@esri/arcgis-rest-developer-credentials 1.1.0 → 2.0.0

package/dist/esm/shared/types/appType.d.ts

@@ -28,7 +28,7 @@ export interface IRegisterAppOptions extends Omit<IRequestOptions, "params"> {
     /**
      * Privilege lists. For more info, refer to {@linkcode Privileges}.
      */
-    privileges: Array<Privileges | `${Privileges}`>;
+    privileges: Privileges;
     /**
      * {@linkcode IAuthenticationManager} authentication.
      */
@@ -61,18 +61,22 @@ export interface IRegisteredAppResponse {
     client_secret: string;
     httpReferrers: string[];
     redirect_uris: string[];
-    privileges: Array<Privileges | `${Privileges}`>;
+    privileges: string[];
     registered: UnixTime;
     modified: UnixTime;
     apnsProdCert: any;
     apnsSandboxCert: any;
     gcmApiKey: any;
     isBeta: boolean;
+    customAppLoginShowTriage: boolean;
+    isPersonalAPIToken: boolean;
+    apiToken1Active: boolean;
+    apiToken2Active: boolean;
 }
 /**
  * Return value of {@linkcode registerApp} and {@linkcode getRegisteredAppInfo} representing an app entity.
  */
-export interface IApp extends Omit<IRegisteredAppResponse, "registered" | "modified" | "apnsProdCert" | "apnsSandboxCert" | "gcmApiKey" | "isBeta"> {
+export interface IApp extends Omit<IRegisteredAppResponse, "registered" | "modified" | "apnsProdCert" | "apnsSandboxCert" | "gcmApiKey" | "isBeta" | "customAppLoginShowTriage"> {
     registered: Date;
     modified: Date;
 }

package/dist/esm/shared/types/appType.js.map

@@ -1 +1 @@
-{"version":3,"file":"appType.js","sourceRoot":"","sources":["../../../../src/shared/types/appType.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  IRequestOptions,\n  IAuthenticationManager\n} from \"@esri/arcgis-rest-request\";\nimport { UnixTime } from \"@esri/arcgis-rest-portal\";\nimport { Privileges } from \"../enum/privileges.js\";\n\n/**\n * Accepted app types.\n */\nexport type AppType = \"apikey\" | \"browser\" | \"native\" | \"server\" | \"multiple\";\n\n/**\n * Options to register an app.\n */\nexport interface IRegisterAppOptions extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * itemId that the newly registered app will be based on.\n   */\n  itemId: string;\n  /**\n   * App types. For more info, refer to {@linkcode AppType}.\n   */\n  appType: AppType;\n  /**\n   * Redirect URIs set for this app.\n   */\n  redirect_uris: string[];\n  /**\n   * Http Referrers set for this app.\n   */\n  httpReferrers: string[];\n  /**\n   * Privilege lists. For more info, refer to {@linkcode Privileges}.\n   */\n  privileges: Array<Privileges | `${Privileges}`>;\n  /**\n   * {@linkcode IAuthenticationManager} authentication.\n   */\n  authentication: IAuthenticationManager;\n}\n\n/**\n * Options to retrieve an app.\n */\nexport interface IGetAppInfoOptions extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * {@linkcode IAuthenticationManager} authentication.\n   */\n  authentication: IAuthenticationManager;\n  /**\n   * itemId of which app to be retrieved.\n   */\n  itemId: string;\n}\n\n/**\n * Raw response of app related endpoints calls.\n */\nexport interface IRegisteredAppResponse {\n  itemId: string;\n  /**\n   * Only to be present if appType is apikey\n   */\n  apiKey?: string;\n  appType: AppType;\n  client_id: string;\n  client_secret: string;\n  httpReferrers: string[];\n  redirect_uris: string[];\n  privileges: Array<Privileges | `${Privileges}`>;\n  registered: UnixTime;\n  modified: UnixTime;\n  apnsProdCert: any;\n  apnsSandboxCert: any;\n  gcmApiKey: any;\n  isBeta: boolean;\n}\n\n/**\n * Return value of {@linkcode registerApp} and {@linkcode getRegisteredAppInfo} representing an app entity.\n */\nexport interface IApp\n  extends Omit<\n    IRegisteredAppResponse,\n    | \"registered\"\n    | \"modified\"\n    | \"apnsProdCert\"\n    | \"apnsSandboxCert\"\n    | \"gcmApiKey\"\n    | \"isBeta\"\n  > {\n  registered: Date;\n  modified: Date;\n}\n\n/**\n * Options to unregister an app.\n */\nexport interface IUnregisterAppOptions extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * {@linkcode IAuthenticationManager} authentication.\n   */\n  authentication: IAuthenticationManager;\n  /**\n   * itemId of which app to be unregistered.\n   */\n  itemId: string;\n}\n\n/**\n * Response of app un-registration.\n */\nexport interface IUnregisterAppResponse {\n  success: true | false;\n  /**\n   * itemId of which app has been unregistered.\n   */\n  itemId: string;\n}\n"]}
+{"version":3,"file":"appType.js","sourceRoot":"","sources":["../../../../src/shared/types/appType.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  IRequestOptions,\n  IAuthenticationManager\n} from \"@esri/arcgis-rest-request\";\nimport { UnixTime } from \"@esri/arcgis-rest-portal\";\nimport { Privileges } from \"../enum/privileges.js\";\n\n/**\n * Accepted app types.\n */\nexport type AppType = \"apikey\" | \"browser\" | \"native\" | \"server\" | \"multiple\";\n\n/**\n * Options to register an app.\n */\nexport interface IRegisterAppOptions extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * itemId that the newly registered app will be based on.\n   */\n  itemId: string;\n  /**\n   * App types. For more info, refer to {@linkcode AppType}.\n   */\n  appType: AppType;\n  /**\n   * Redirect URIs set for this app.\n   */\n  redirect_uris: string[];\n  /**\n   * Http Referrers set for this app.\n   */\n  httpReferrers: string[];\n  /**\n   * Privilege lists. For more info, refer to {@linkcode Privileges}.\n   */\n  privileges: Privileges;\n  /**\n   * {@linkcode IAuthenticationManager} authentication.\n   */\n  authentication: IAuthenticationManager;\n}\n\n/**\n * Options to retrieve an app.\n */\nexport interface IGetAppInfoOptions extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * {@linkcode IAuthenticationManager} authentication.\n   */\n  authentication: IAuthenticationManager;\n  /**\n   * itemId of which app to be retrieved.\n   */\n  itemId: string;\n}\n\n/**\n * Raw response of app related endpoints calls.\n */\nexport interface IRegisteredAppResponse {\n  itemId: string;\n  /**\n   * Only to be present if appType is apikey\n   */\n  apiKey?: string;\n  appType: AppType;\n  client_id: string;\n  client_secret: string;\n  httpReferrers: string[];\n  redirect_uris: string[];\n  privileges: string[];\n  registered: UnixTime;\n  modified: UnixTime;\n  apnsProdCert: any;\n  apnsSandboxCert: any;\n  gcmApiKey: any;\n  isBeta: boolean;\n  customAppLoginShowTriage: boolean;\n  isPersonalAPIToken: boolean;\n  apiToken1Active: boolean;\n  apiToken2Active: boolean;\n}\n\n/**\n * Return value of {@linkcode registerApp} and {@linkcode getRegisteredAppInfo} representing an app entity.\n */\nexport interface IApp\n  extends Omit<\n    IRegisteredAppResponse,\n    | \"registered\"\n    | \"modified\"\n    | \"apnsProdCert\"\n    | \"apnsSandboxCert\"\n    | \"gcmApiKey\"\n    | \"isBeta\"\n    | \"customAppLoginShowTriage\"\n  > {\n  registered: Date;\n  modified: Date;\n}\n\n/**\n * Options to unregister an app.\n */\nexport interface IUnregisterAppOptions extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * {@linkcode IAuthenticationManager} authentication.\n   */\n  authentication: IAuthenticationManager;\n  /**\n   * itemId of which app to be unregistered.\n   */\n  itemId: string;\n}\n\n/**\n * Response of app un-registration.\n */\nexport interface IUnregisterAppResponse {\n  success: true | false;\n  /**\n   * itemId of which app has been unregistered.\n   */\n  itemId: string;\n}\n"]}

package/dist/esm/updateApiKey.js

@@ -1,8 +1,8 @@
 /* Copyright (c) 2023 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 import { getRegisteredAppInfo } from "./shared/getRegisteredAppInfo.js";
-import { appToApiKeyProperties, extractBaseRequestOptions, arePrivilegesValid, stringifyArrays, registeredAppResponseToApp } from "./shared/helpers.js";
-import { getItem, getPortalUrl } from "@esri/arcgis-rest-portal";
+import { appToApiKeyProperties, extractBaseRequestOptions, stringifyArrays, generateApiKeyTokens, generateOptionsToSlots, buildExpirationDateParams } from "./shared/helpers.js";
+import { getItem, getPortalUrl, updateItem } from "@esri/arcgis-rest-portal";
 import { appendCustomParams, request } from "@esri/arcgis-rest-request";
 /**
  * Used to update an API key.
@@ -36,20 +36,21 @@ import { appendCustomParams, request } from "@esri/arcgis-rest-request";
  * @returns A Promise that will resolve to an {@linkcode IApiKeyResponse} object representing updated API key.
  */
 export async function updateApiKey(requestOptions) {
-    // privileges validation
-    if (requestOptions.privileges &&
-        !arePrivilegesValid(requestOptions.privileges)) {
-        throw new Error("The `privileges` option contains invalid privileges.");
-    }
     requestOptions.httpMethod = "POST";
-    // get app
     const baseRequestOptions = extractBaseRequestOptions(requestOptions); // get base requestOptions snapshot
+    /**
+     * step 1: update expiration dates if provided. Build the object up to avoid overwriting any existing properties.
+     */
+    if (requestOptions.apiToken1ExpirationDate ||
+        requestOptions.apiToken2ExpirationDate) {
+        const updateParams = buildExpirationDateParams(requestOptions);
+        await updateItem(Object.assign(Object.assign({}, baseRequestOptions), { item: Object.assign({ id: requestOptions.itemId }, updateParams), authentication: requestOptions.authentication }));
+    }
+    /**
+     * step 2: update privileges and httpReferrers if provided. Build the object up to avoid overwriting any existing properties.
+     */
     const getAppOption = Object.assign(Object.assign({}, baseRequestOptions), { authentication: requestOptions.authentication, itemId: requestOptions.itemId });
     const appResponse = await getRegisteredAppInfo(getAppOption);
-    // appType must be APIKey to continue
-    if (appResponse.appType !== "apikey" || !("apiKey" in appResponse)) {
-        throw new Error("Item is not an API key.");
-    }
     const clientId = appResponse.client_id;
     const options = appendCustomParams(Object.assign(Object.assign({}, appResponse), requestOptions), // object with the custom params to look in
     ["privileges", "httpReferrers"] // keys you want copied to the params object
@@ -60,8 +61,18 @@ export async function updateApiKey(requestOptions) {
     const url = getPortalUrl(options) + `/oauth2/apps/${clientId}/update`;
     // Raw response from `/oauth2/apps/${clientId}/update`, apiKey not included because key is same.
     const updateResponse = await request(url, Object.assign(Object.assign({}, options), { authentication: requestOptions.authentication }));
-    const app = registeredAppResponseToApp(Object.assign(Object.assign({}, updateResponse), { apiKey: appResponse.apiKey }));
-    const itemInfo = await getItem(requestOptions.itemId, Object.assign(Object.assign({}, baseRequestOptions), { authentication: requestOptions.authentication, params: { f: "json" } }));
-    return Object.assign(Object.assign({}, appToApiKeyProperties(app)), { item: itemInfo });
+    /**
+     * step 3: get the updated item info to return to the user.
+     */
+    const updatedItemInfo = await getItem(requestOptions.itemId, Object.assign(Object.assign({}, baseRequestOptions), { authentication: requestOptions.authentication, params: { f: "json" } }));
+    /**
+     * step 4: generate tokens if requested
+     */
+    const generatedTokens = await generateApiKeyTokens(requestOptions.itemId, generateOptionsToSlots(requestOptions.generateToken1, requestOptions.generateToken2), Object.assign(Object.assign({}, baseRequestOptions), { authentication: requestOptions.authentication }));
+    /**
+     * step 5: get updated registered app info
+     */
+    const updatedRegisteredAppResponse = await getRegisteredAppInfo(Object.assign(Object.assign({}, baseRequestOptions), { itemId: requestOptions.itemId, authentication: requestOptions.authentication }));
+    return Object.assign(Object.assign(Object.assign({}, generatedTokens), appToApiKeyProperties(updatedRegisteredAppResponse)), { item: updatedItemInfo });
 }
 //# sourceMappingURL=updateApiKey.js.map

package/dist/esm/updateApiKey.js.map

@@ -1 +1 @@
-{"version":3,"file":"updateApiKey.js","sourceRoot":"","sources":["../../src/updateApiKey.ts"],"names":[],"mappings":"AAAA;gBACgB;AAMhB,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EACL,qBAAqB,EACrB,yBAAyB,EACzB,kBAAkB,EAClB,eAAe,EACf,0BAA0B,EAC3B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAOxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,cAAoC;IAEpC,wBAAwB;IACxB,IACE,cAAc,CAAC,UAAU;QACzB,CAAC,kBAAkB,CAAC,cAAc,CAAC,UAAU,CAAC,EAC9C;QACA,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;KACzE;IAED,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC;IAEnC,UAAU;IACV,MAAM,kBAAkB,GAAG,yBAAyB,CAAC,cAAc,CAAC,CAAC,CAAC,mCAAmC;IACzG,MAAM,YAAY,mCACb,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE,cAAc,CAAC,MAAM,GAC9B,CAAC;IAEF,MAAM,WAAW,GAAG,MAAM,oBAAoB,CAAC,YAAY,CAAC,CAAC;IAE7D,qCAAqC;IACrC,IAAI,WAAW,CAAC,OAAO,KAAK,QAAQ,IAAI,CAAC,CAAC,QAAQ,IAAI,WAAW,CAAC,EAAE;QAClE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;KAC5C;IAED,MAAM,QAAQ,GAAG,WAAW,CAAC,SAAS,CAAC;IACvC,MAAM,OAAO,GAAG,kBAAkB,iCAC3B,WAAW,GAAK,cAAc,GAAI,2CAA2C;IAClF,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,4CAA4C;KAC7E,CAAC;IACF,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC;IAE1B,mHAAmH;IACnH,eAAe,CAAC,OAAO,CAAC,CAAC;IAEzB,MAAM,GAAG,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,gBAAgB,QAAQ,SAAS,CAAC;IAEtE,gGAAgG;IAChG,MAAM,cAAc,GAA2B,MAAM,OAAO,CAAC,GAAG,kCAC3D,OAAO,KACV,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH,MAAM,GAAG,GAAS,0BAA0B,iCACvC,cAAc,KACjB,MAAM,EAAE,WAAW,CAAC,MAAM,IAC1B,CAAC;IAEH,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,MAAM,kCAC/C,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,IACrB,CAAC;IAEH,uCACK,qBAAqB,CAAC,GAAG,CAAC,KAC7B,IAAI,EAAE,QAAQ,IACd;AACJ,CAAC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  IApiKeyResponse,\n  IUpdateApiKeyOptions\n} from \"./shared/types/apiKeyType.js\";\nimport { getRegisteredAppInfo } from \"./shared/getRegisteredAppInfo.js\";\nimport {\n  appToApiKeyProperties,\n  extractBaseRequestOptions,\n  arePrivilegesValid,\n  stringifyArrays,\n  registeredAppResponseToApp\n} from \"./shared/helpers.js\";\nimport { getItem, getPortalUrl } from \"@esri/arcgis-rest-portal\";\nimport { appendCustomParams, request } from \"@esri/arcgis-rest-request\";\nimport {\n  IApp,\n  IGetAppInfoOptions,\n  IRegisteredAppResponse\n} from \"./shared/types/appType.js\";\n\n/**\n * Used to update an API key.\n *\n * Notes about `privileges` and `httpReferrers` options:\n * 1. Provided option will override corresponding old option.\n * 2. Unprovided option will not trigger corresponding option updates.\n *\n * ```js\n * import { updateApiKey, IApiKeyResponse } from '@esri/arcgis-rest-developer-credentials';\n * import { ArcGISIdentityManager } from \"@esri/arcgis-rest-request\";\n *\n * const authSession: ArcGISIdentityManager = await ArcGISIdentityManager.signIn({\n *   username: \"xyz_usrName\",\n *   password: \"xyz_pw\"\n * });\n *\n * updateApiKey({\n *   itemId: \"xyz_itemId\",\n *   privileges: [Privileges.Geocode],\n *   httpReferrers: [], // httpReferrers will be set to be empty\n *   authentication: authSession\n * }).then((updatedAPIKey: IApiKeyResponse) => {\n *   // => {apiKey: \"xyz_key\", item: {tags: [\"xyz_tag1\", \"xyz_tag2\"], ...}, ...}\n * }).catch(e => {\n *   // => an exception object\n * });\n * ```\n *\n * @param requestOptions - Options for {@linkcode updateApiKey | updateApiKey()}, including `itemId` of which API key to be operated on, optional new `privileges`, optional new `httpReferrers` and an {@linkcode ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IApiKeyResponse} object representing updated API key.\n */\nexport async function updateApiKey(\n  requestOptions: IUpdateApiKeyOptions\n): Promise<IApiKeyResponse> {\n  // privileges validation\n  if (\n    requestOptions.privileges &&\n    !arePrivilegesValid(requestOptions.privileges)\n  ) {\n    throw new Error(\"The `privileges` option contains invalid privileges.\");\n  }\n\n  requestOptions.httpMethod = \"POST\";\n\n  // get app\n  const baseRequestOptions = extractBaseRequestOptions(requestOptions); // get base requestOptions snapshot\n  const getAppOption: IGetAppInfoOptions = {\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication,\n    itemId: requestOptions.itemId\n  };\n\n  const appResponse = await getRegisteredAppInfo(getAppOption);\n\n  // appType must be APIKey to continue\n  if (appResponse.appType !== \"apikey\" || !(\"apiKey\" in appResponse)) {\n    throw new Error(\"Item is not an API key.\");\n  }\n\n  const clientId = appResponse.client_id;\n  const options = appendCustomParams(\n    { ...appResponse, ...requestOptions }, // object with the custom params to look in\n    [\"privileges\", \"httpReferrers\"] // keys you want copied to the params object\n  );\n  options.params.f = \"json\";\n\n  // encode special params value (e.g. array type...) in advance in order to make encodeQueryString() works correctly\n  stringifyArrays(options);\n\n  const url = getPortalUrl(options) + `/oauth2/apps/${clientId}/update`;\n\n  // Raw response from `/oauth2/apps/${clientId}/update`, apiKey not included because key is same.\n  const updateResponse: IRegisteredAppResponse = await request(url, {\n    ...options,\n    authentication: requestOptions.authentication\n  });\n\n  const app: IApp = registeredAppResponseToApp({\n    ...updateResponse,\n    apiKey: appResponse.apiKey\n  });\n\n  const itemInfo = await getItem(requestOptions.itemId, {\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication,\n    params: { f: \"json\" }\n  });\n\n  return {\n    ...appToApiKeyProperties(app),\n    item: itemInfo\n  };\n}\n"]}
+{"version":3,"file":"updateApiKey.js","sourceRoot":"","sources":["../../src/updateApiKey.ts"],"names":[],"mappings":"AAAA;gBACgB;AAMhB,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EACL,qBAAqB,EACrB,yBAAyB,EACzB,eAAe,EAEf,oBAAoB,EACpB,sBAAsB,EACtB,yBAAyB,EAC1B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAC7E,OAAO,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAOxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,cAAoC;IAEpC,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC;IACnC,MAAM,kBAAkB,GAAG,yBAAyB,CAAC,cAAc,CAAC,CAAC,CAAC,mCAAmC;IAEzG;;OAEG;IACH,IACE,cAAc,CAAC,uBAAuB;QACtC,cAAc,CAAC,uBAAuB,EACtC;QACA,MAAM,YAAY,GAAG,yBAAyB,CAAC,cAAc,CAAC,CAAC;QAC/D,MAAM,UAAU,iCACX,kBAAkB,KACrB,IAAI,kBACF,EAAE,EAAE,cAAc,CAAC,MAAM,IACtB,YAAY,GAEjB,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;KACJ;IAED;;OAEG;IACH,MAAM,YAAY,mCACb,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE,cAAc,CAAC,MAAM,GAC9B,CAAC;IACF,MAAM,WAAW,GAAG,MAAM,oBAAoB,CAAC,YAAY,CAAC,CAAC;IAC7D,MAAM,QAAQ,GAAG,WAAW,CAAC,SAAS,CAAC;IACvC,MAAM,OAAO,GAAG,kBAAkB,iCAC3B,WAAW,GAAK,cAAc,GAAI,2CAA2C;IAClF,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,4CAA4C;KAC7E,CAAC;IACF,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC;IAE1B,mHAAmH;IACnH,eAAe,CAAC,OAAO,CAAC,CAAC;IAEzB,MAAM,GAAG,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,gBAAgB,QAAQ,SAAS,CAAC;IAEtE,gGAAgG;IAChG,MAAM,cAAc,GAA2B,MAAM,OAAO,CAAC,GAAG,kCAC3D,OAAO,KACV,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH;;OAEG;IACH,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,MAAM,kCACtD,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,IACrB,CAAC;IAEH;;OAEG;IACH,MAAM,eAAe,GAAG,MAAM,oBAAoB,CAChD,cAAc,CAAC,MAAM,EACrB,sBAAsB,CACpB,cAAc,CAAC,cAAc,EAC7B,cAAc,CAAC,cAAc,CAC9B,kCAEI,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,IAEhD,CAAC;IAEF;;OAEG;IACH,MAAM,4BAA4B,GAAG,MAAM,oBAAoB,iCAC1D,kBAAkB,KACrB,MAAM,EAAE,cAAc,CAAC,MAAM,EAC7B,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH,qDACK,eAAe,GACf,qBAAqB,CAAC,4BAA4B,CAAC,KACtD,IAAI,EAAE,eAAe,IACrB;AACJ,CAAC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  IApiKeyResponse,\n  IUpdateApiKeyOptions\n} from \"./shared/types/apiKeyType.js\";\nimport { getRegisteredAppInfo } from \"./shared/getRegisteredAppInfo.js\";\nimport {\n  appToApiKeyProperties,\n  extractBaseRequestOptions,\n  stringifyArrays,\n  registeredAppResponseToApp,\n  generateApiKeyTokens,\n  generateOptionsToSlots,\n  buildExpirationDateParams\n} from \"./shared/helpers.js\";\nimport { getItem, getPortalUrl, updateItem } from \"@esri/arcgis-rest-portal\";\nimport { appendCustomParams, request } from \"@esri/arcgis-rest-request\";\nimport {\n  IApp,\n  IGetAppInfoOptions,\n  IRegisteredAppResponse\n} from \"./shared/types/appType.js\";\n\n/**\n * Used to update an API key.\n *\n * Notes about `privileges` and `httpReferrers` options:\n * 1. Provided option will override corresponding old option.\n * 2. Unprovided option will not trigger corresponding option updates.\n *\n * ```js\n * import { updateApiKey, IApiKeyResponse } from '@esri/arcgis-rest-developer-credentials';\n * import { ArcGISIdentityManager } from \"@esri/arcgis-rest-request\";\n *\n * const authSession: ArcGISIdentityManager = await ArcGISIdentityManager.signIn({\n *   username: \"xyz_usrName\",\n *   password: \"xyz_pw\"\n * });\n *\n * updateApiKey({\n *   itemId: \"xyz_itemId\",\n *   privileges: [Privileges.Geocode],\n *   httpReferrers: [], // httpReferrers will be set to be empty\n *   authentication: authSession\n * }).then((updatedAPIKey: IApiKeyResponse) => {\n *   // => {apiKey: \"xyz_key\", item: {tags: [\"xyz_tag1\", \"xyz_tag2\"], ...}, ...}\n * }).catch(e => {\n *   // => an exception object\n * });\n * ```\n *\n * @param requestOptions - Options for {@linkcode updateApiKey | updateApiKey()}, including `itemId` of which API key to be operated on, optional new `privileges`, optional new `httpReferrers` and an {@linkcode ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IApiKeyResponse} object representing updated API key.\n */\nexport async function updateApiKey(\n  requestOptions: IUpdateApiKeyOptions\n): Promise<IApiKeyResponse> {\n  requestOptions.httpMethod = \"POST\";\n  const baseRequestOptions = extractBaseRequestOptions(requestOptions); // get base requestOptions snapshot\n\n  /**\n   * step 1: update expiration dates if provided. Build the object up to avoid overwriting any existing properties.\n   */\n  if (\n    requestOptions.apiToken1ExpirationDate ||\n    requestOptions.apiToken2ExpirationDate\n  ) {\n    const updateParams = buildExpirationDateParams(requestOptions);\n    await updateItem({\n      ...baseRequestOptions,\n      item: {\n        id: requestOptions.itemId,\n        ...updateParams\n      },\n      authentication: requestOptions.authentication\n    });\n  }\n\n  /**\n   * step 2: update privileges and httpReferrers if provided. Build the object up to avoid overwriting any existing properties.\n   */\n  const getAppOption: IGetAppInfoOptions = {\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication,\n    itemId: requestOptions.itemId\n  };\n  const appResponse = await getRegisteredAppInfo(getAppOption);\n  const clientId = appResponse.client_id;\n  const options = appendCustomParams(\n    { ...appResponse, ...requestOptions }, // object with the custom params to look in\n    [\"privileges\", \"httpReferrers\"] // keys you want copied to the params object\n  );\n  options.params.f = \"json\";\n\n  // encode special params value (e.g. array type...) in advance in order to make encodeQueryString() works correctly\n  stringifyArrays(options);\n\n  const url = getPortalUrl(options) + `/oauth2/apps/${clientId}/update`;\n\n  // Raw response from `/oauth2/apps/${clientId}/update`, apiKey not included because key is same.\n  const updateResponse: IRegisteredAppResponse = await request(url, {\n    ...options,\n    authentication: requestOptions.authentication\n  });\n\n  /**\n   * step 3: get the updated item info to return to the user.\n   */\n  const updatedItemInfo = await getItem(requestOptions.itemId, {\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication,\n    params: { f: \"json\" }\n  });\n\n  /**\n   * step 4: generate tokens if requested\n   */\n  const generatedTokens = await generateApiKeyTokens(\n    requestOptions.itemId,\n    generateOptionsToSlots(\n      requestOptions.generateToken1,\n      requestOptions.generateToken2\n    ),\n    {\n      ...baseRequestOptions,\n      authentication: requestOptions.authentication\n    }\n  );\n\n  /**\n   * step 5: get updated registered app info\n   */\n  const updatedRegisteredAppResponse = await getRegisteredAppInfo({\n    ...baseRequestOptions,\n    itemId: requestOptions.itemId,\n    authentication: requestOptions.authentication\n  });\n\n  return {\n    ...generatedTokens,\n    ...appToApiKeyProperties(updatedRegisteredAppResponse),\n    item: updatedItemInfo\n  };\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/arcgis-rest-developer-credentials",
-  "version": "1.1.0",
+  "version": "2.0.0",
   "description": "Developer Credentials for @esri/arcgis-rest-js",
   "license": "Apache-2.0",
   "keywords": [

package/dist/cjs/deleteApiKey.js

@@ -1,43 +0,0 @@
-"use strict";
-/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.
- * Apache-2.0 */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.deleteApiKey = void 0;
-const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
-const helpers_js_1 = require("./shared/helpers.js");
-const getApiKey_js_1 = require("./getApiKey.js");
-/**
- * Used to delete the API Key with given `itemId`.
- *
- * ```js
- * import { deleteApiKey, IDeleteApiKeyResponse } from '@esri/arcgis-rest-developer-credentials';
- * import { ArcGISIdentityManager } from "@esri/arcgis-rest-request";
- *
- * const authSession: ArcGISIdentityManager = await ArcGISIdentityManager.signIn({
- *   username: "xyz_usrName",
- *   password: "xyz_pw"
- * });
- *
- * deleteApiKey({
- *   itemId: "xyz_itemId",
- *   authentication: authSession
- * }).then((deletedApiKey: IDeleteApiKeyResponse) => {
- *   // => {itemId: "xyz_itemId", success: true}
- * }).catch(e => {
- *   // => an exception object
- * });
- * ```
- *
- * @param requestOptions - Options for {@linkcode deleteApiKey | deleteApiKey()}, including `itemId` of which API key to be deleted and an {@linkcode ArcGISIdentityManager} authentication session.
- * @returns A Promise that will resolve to an {@linkcode IDeleteApiKeyResponse} object representing deletion status.
- */
-async function deleteApiKey(requestOptions) {
-    requestOptions.httpMethod = "POST";
-    const baseRequestOptions = (0, helpers_js_1.extractBaseRequestOptions)(requestOptions);
-    // validate provided itemId associates with API Key
-    await (0, getApiKey_js_1.getApiKey)(Object.assign(Object.assign({}, baseRequestOptions), { itemId: requestOptions.itemId, authentication: requestOptions.authentication }));
-    const removeItemResponse = await (0, arcgis_rest_portal_1.removeItem)(Object.assign(Object.assign({}, baseRequestOptions), { id: requestOptions.itemId, authentication: requestOptions.authentication, params: { f: "json" } }));
-    return removeItemResponse;
-}
-exports.deleteApiKey = deleteApiKey;
-//# sourceMappingURL=deleteApiKey.js.map

package/dist/cjs/deleteApiKey.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"deleteApiKey.js","sourceRoot":"","sources":["../../src/deleteApiKey.ts"],"names":[],"mappings":";AAAA;gBACgB;;;AAEhB,iEAAsD;AAEtD,oDAAgE;AAKhE,iDAA2C;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACI,KAAK,UAAU,YAAY,CAChC,cAAmC;IAEnC,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC;IAEnC,MAAM,kBAAkB,GAAG,IAAA,sCAAyB,EAAC,cAAc,CAAC,CAAC;IAErE,mDAAmD;IACnD,MAAM,IAAA,wBAAS,kCACV,kBAAkB,KACrB,MAAM,EAAE,cAAc,CAAC,MAAM,EAC7B,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH,MAAM,kBAAkB,GAA0B,MAAM,IAAA,+BAAU,kCAC7D,kBAAkB,KACrB,EAAE,EAAE,cAAc,CAAC,MAAM,EACzB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,IACrB,CAAC;IAEH,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAtBD,oCAsBC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport { removeItem } from \"@esri/arcgis-rest-portal\";\n\nimport { extractBaseRequestOptions } from \"./shared/helpers.js\";\nimport {\n  IDeleteApiKeyOption,\n  IDeleteApiKeyResponse\n} from \"./shared/types/apiKeyType.js\";\nimport { getApiKey } from \"./getApiKey.js\";\n\n/**\n * Used to delete the API Key with given `itemId`.\n *\n * ```js\n * import { deleteApiKey, IDeleteApiKeyResponse } from '@esri/arcgis-rest-developer-credentials';\n * import { ArcGISIdentityManager } from \"@esri/arcgis-rest-request\";\n *\n * const authSession: ArcGISIdentityManager = await ArcGISIdentityManager.signIn({\n *   username: \"xyz_usrName\",\n *   password: \"xyz_pw\"\n * });\n *\n * deleteApiKey({\n *   itemId: \"xyz_itemId\",\n *   authentication: authSession\n * }).then((deletedApiKey: IDeleteApiKeyResponse) => {\n *   // => {itemId: \"xyz_itemId\", success: true}\n * }).catch(e => {\n *   // => an exception object\n * });\n * ```\n *\n * @param requestOptions - Options for {@linkcode deleteApiKey | deleteApiKey()}, including `itemId` of which API key to be deleted and an {@linkcode ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IDeleteApiKeyResponse} object representing deletion status.\n */\nexport async function deleteApiKey(\n  requestOptions: IDeleteApiKeyOption\n): Promise<IDeleteApiKeyResponse> {\n  requestOptions.httpMethod = \"POST\";\n\n  const baseRequestOptions = extractBaseRequestOptions(requestOptions);\n\n  // validate provided itemId associates with API Key\n  await getApiKey({\n    ...baseRequestOptions,\n    itemId: requestOptions.itemId,\n    authentication: requestOptions.authentication\n  });\n\n  const removeItemResponse: IDeleteApiKeyResponse = await removeItem({\n    ...baseRequestOptions,\n    id: requestOptions.itemId,\n    authentication: requestOptions.authentication,\n    params: { f: \"json\" }\n  });\n\n  return removeItemResponse;\n}\n"]}

package/dist/cjs/deleteOAuthApp.js

@@ -1,43 +0,0 @@
-"use strict";
-/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.
- * Apache-2.0 */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.deleteOAuthApp = void 0;
-const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
-const helpers_js_1 = require("./shared/helpers.js");
-const getOAuthApp_js_1 = require("./getOAuthApp.js");
-/**
- * Used to delete the OAuth2.0 app with given `itemId`.
- *
- * ```js
- * import { deleteOAuthApp, IDeleteOAuthAppResponse } from '@esri/arcgis-rest-developer-credentials';
- * import { ArcGISIdentityManager } from "@esri/arcgis-rest-request";
- *
- * const authSession: ArcGISIdentityManager = await ArcGISIdentityManager.signIn({
- *   username: "xyz_usrName",
- *   password: "xyz_pw"
- * });
- *
- * deleteOAuthApp({
- *   itemId: "xyz_itemId",
- *   authentication: authSession
- * }).then((deletedOAuthApp: IDeleteOAuthAppResponse) => {
- *   // => {itemId: "xyz_itemId", success: true}
- * }).catch(e => {
- *   // => an exception object
- * });
- * ```
- *
- * @param requestOptions - Options for {@linkcode deleteOAuthApp | deleteOAuthApp()}, including `itemId` of which OAuth app to be deleted and an {@linkcode ArcGISIdentityManager} authentication session.
- * @returns A Promise that will resolve to an {@linkcode IDeleteOAuthAppResponse} object representing deletion status.
- */
-async function deleteOAuthApp(requestOptions) {
-    requestOptions.httpMethod = "POST";
-    const baseRequestOptions = (0, helpers_js_1.extractBaseRequestOptions)(requestOptions);
-    // validate provided itemId associates with OAuth app
-    await (0, getOAuthApp_js_1.getOAuthApp)(Object.assign(Object.assign({}, baseRequestOptions), { itemId: requestOptions.itemId, authentication: requestOptions.authentication }));
-    const removeItemResponse = await (0, arcgis_rest_portal_1.removeItem)(Object.assign(Object.assign({}, baseRequestOptions), { id: requestOptions.itemId, authentication: requestOptions.authentication, params: { f: "json" } }));
-    return removeItemResponse;
-}
-exports.deleteOAuthApp = deleteOAuthApp;
-//# sourceMappingURL=deleteOAuthApp.js.map

package/dist/cjs/deleteOAuthApp.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"deleteOAuthApp.js","sourceRoot":"","sources":["../../src/deleteOAuthApp.ts"],"names":[],"mappings":";AAAA;gBACgB;;;AAEhB,iEAAsD;AAEtD,oDAAgE;AAKhE,qDAA+C;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACI,KAAK,UAAU,cAAc,CAClC,cAAqC;IAErC,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC;IAEnC,MAAM,kBAAkB,GAAG,IAAA,sCAAyB,EAAC,cAAc,CAAC,CAAC;IAErE,qDAAqD;IACrD,MAAM,IAAA,4BAAW,kCACZ,kBAAkB,KACrB,MAAM,EAAE,cAAc,CAAC,MAAM,EAC7B,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH,MAAM,kBAAkB,GAA4B,MAAM,IAAA,+BAAU,kCAC/D,kBAAkB,KACrB,EAAE,EAAE,cAAc,CAAC,MAAM,EACzB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,IACrB,CAAC;IAEH,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAtBD,wCAsBC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport { removeItem } from \"@esri/arcgis-rest-portal\";\n\nimport { extractBaseRequestOptions } from \"./shared/helpers.js\";\nimport {\n  IDeleteOAuthAppOption,\n  IDeleteOAuthAppResponse\n} from \"./shared/types/oAuthType.js\";\nimport { getOAuthApp } from \"./getOAuthApp.js\";\n\n/**\n * Used to delete the OAuth2.0 app with given `itemId`.\n *\n * ```js\n * import { deleteOAuthApp, IDeleteOAuthAppResponse } from '@esri/arcgis-rest-developer-credentials';\n * import { ArcGISIdentityManager } from \"@esri/arcgis-rest-request\";\n *\n * const authSession: ArcGISIdentityManager = await ArcGISIdentityManager.signIn({\n *   username: \"xyz_usrName\",\n *   password: \"xyz_pw\"\n * });\n *\n * deleteOAuthApp({\n *   itemId: \"xyz_itemId\",\n *   authentication: authSession\n * }).then((deletedOAuthApp: IDeleteOAuthAppResponse) => {\n *   // => {itemId: \"xyz_itemId\", success: true}\n * }).catch(e => {\n *   // => an exception object\n * });\n * ```\n *\n * @param requestOptions - Options for {@linkcode deleteOAuthApp | deleteOAuthApp()}, including `itemId` of which OAuth app to be deleted and an {@linkcode ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IDeleteOAuthAppResponse} object representing deletion status.\n */\nexport async function deleteOAuthApp(\n  requestOptions: IDeleteOAuthAppOption\n): Promise<IDeleteOAuthAppResponse> {\n  requestOptions.httpMethod = \"POST\";\n\n  const baseRequestOptions = extractBaseRequestOptions(requestOptions);\n\n  // validate provided itemId associates with OAuth app\n  await getOAuthApp({\n    ...baseRequestOptions,\n    itemId: requestOptions.itemId,\n    authentication: requestOptions.authentication\n  });\n\n  const removeItemResponse: IDeleteOAuthAppResponse = await removeItem({\n    ...baseRequestOptions,\n    id: requestOptions.itemId,\n    authentication: requestOptions.authentication,\n    params: { f: \"json\" }\n  });\n\n  return removeItemResponse;\n}\n"]}

package/dist/esm/deleteApiKey.d.ts

@@ -1,27 +0,0 @@
-import { IDeleteApiKeyOption, IDeleteApiKeyResponse } from "./shared/types/apiKeyType.js";
-/**
- * Used to delete the API Key with given `itemId`.
- *
- * ```js
- * import { deleteApiKey, IDeleteApiKeyResponse } from '@esri/arcgis-rest-developer-credentials';
- * import { ArcGISIdentityManager } from "@esri/arcgis-rest-request";
- *
- * const authSession: ArcGISIdentityManager = await ArcGISIdentityManager.signIn({
- *   username: "xyz_usrName",
- *   password: "xyz_pw"
- * });
- *
- * deleteApiKey({
- *   itemId: "xyz_itemId",
- *   authentication: authSession
- * }).then((deletedApiKey: IDeleteApiKeyResponse) => {
- *   // => {itemId: "xyz_itemId", success: true}
- * }).catch(e => {
- *   // => an exception object
- * });
- * ```
- *
- * @param requestOptions - Options for {@linkcode deleteApiKey | deleteApiKey()}, including `itemId` of which API key to be deleted and an {@linkcode ArcGISIdentityManager} authentication session.
- * @returns A Promise that will resolve to an {@linkcode IDeleteApiKeyResponse} object representing deletion status.
- */
-export declare function deleteApiKey(requestOptions: IDeleteApiKeyOption): Promise<IDeleteApiKeyResponse>;

package/dist/esm/deleteApiKey.js

@@ -1,39 +0,0 @@
-/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.
- * Apache-2.0 */
-import { removeItem } from "@esri/arcgis-rest-portal";
-import { extractBaseRequestOptions } from "./shared/helpers.js";
-import { getApiKey } from "./getApiKey.js";
-/**
- * Used to delete the API Key with given `itemId`.
- *
- * ```js
- * import { deleteApiKey, IDeleteApiKeyResponse } from '@esri/arcgis-rest-developer-credentials';
- * import { ArcGISIdentityManager } from "@esri/arcgis-rest-request";
- *
- * const authSession: ArcGISIdentityManager = await ArcGISIdentityManager.signIn({
- *   username: "xyz_usrName",
- *   password: "xyz_pw"
- * });
- *
- * deleteApiKey({
- *   itemId: "xyz_itemId",
- *   authentication: authSession
- * }).then((deletedApiKey: IDeleteApiKeyResponse) => {
- *   // => {itemId: "xyz_itemId", success: true}
- * }).catch(e => {
- *   // => an exception object
- * });
- * ```
- *
- * @param requestOptions - Options for {@linkcode deleteApiKey | deleteApiKey()}, including `itemId` of which API key to be deleted and an {@linkcode ArcGISIdentityManager} authentication session.
- * @returns A Promise that will resolve to an {@linkcode IDeleteApiKeyResponse} object representing deletion status.
- */
-export async function deleteApiKey(requestOptions) {
-    requestOptions.httpMethod = "POST";
-    const baseRequestOptions = extractBaseRequestOptions(requestOptions);
-    // validate provided itemId associates with API Key
-    await getApiKey(Object.assign(Object.assign({}, baseRequestOptions), { itemId: requestOptions.itemId, authentication: requestOptions.authentication }));
-    const removeItemResponse = await removeItem(Object.assign(Object.assign({}, baseRequestOptions), { id: requestOptions.itemId, authentication: requestOptions.authentication, params: { f: "json" } }));
-    return removeItemResponse;
-}
-//# sourceMappingURL=deleteApiKey.js.map

package/dist/esm/deleteApiKey.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"deleteApiKey.js","sourceRoot":"","sources":["../../src/deleteApiKey.ts"],"names":[],"mappings":"AAAA;gBACgB;AAEhB,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAEtD,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAKhE,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,cAAmC;IAEnC,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC;IAEnC,MAAM,kBAAkB,GAAG,yBAAyB,CAAC,cAAc,CAAC,CAAC;IAErE,mDAAmD;IACnD,MAAM,SAAS,iCACV,kBAAkB,KACrB,MAAM,EAAE,cAAc,CAAC,MAAM,EAC7B,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH,MAAM,kBAAkB,GAA0B,MAAM,UAAU,iCAC7D,kBAAkB,KACrB,EAAE,EAAE,cAAc,CAAC,MAAM,EACzB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,IACrB,CAAC;IAEH,OAAO,kBAAkB,CAAC;AAC5B,CAAC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport { removeItem } from \"@esri/arcgis-rest-portal\";\n\nimport { extractBaseRequestOptions } from \"./shared/helpers.js\";\nimport {\n  IDeleteApiKeyOption,\n  IDeleteApiKeyResponse\n} from \"./shared/types/apiKeyType.js\";\nimport { getApiKey } from \"./getApiKey.js\";\n\n/**\n * Used to delete the API Key with given `itemId`.\n *\n * ```js\n * import { deleteApiKey, IDeleteApiKeyResponse } from '@esri/arcgis-rest-developer-credentials';\n * import { ArcGISIdentityManager } from \"@esri/arcgis-rest-request\";\n *\n * const authSession: ArcGISIdentityManager = await ArcGISIdentityManager.signIn({\n *   username: \"xyz_usrName\",\n *   password: \"xyz_pw\"\n * });\n *\n * deleteApiKey({\n *   itemId: \"xyz_itemId\",\n *   authentication: authSession\n * }).then((deletedApiKey: IDeleteApiKeyResponse) => {\n *   // => {itemId: \"xyz_itemId\", success: true}\n * }).catch(e => {\n *   // => an exception object\n * });\n * ```\n *\n * @param requestOptions - Options for {@linkcode deleteApiKey | deleteApiKey()}, including `itemId` of which API key to be deleted and an {@linkcode ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IDeleteApiKeyResponse} object representing deletion status.\n */\nexport async function deleteApiKey(\n  requestOptions: IDeleteApiKeyOption\n): Promise<IDeleteApiKeyResponse> {\n  requestOptions.httpMethod = \"POST\";\n\n  const baseRequestOptions = extractBaseRequestOptions(requestOptions);\n\n  // validate provided itemId associates with API Key\n  await getApiKey({\n    ...baseRequestOptions,\n    itemId: requestOptions.itemId,\n    authentication: requestOptions.authentication\n  });\n\n  const removeItemResponse: IDeleteApiKeyResponse = await removeItem({\n    ...baseRequestOptions,\n    id: requestOptions.itemId,\n    authentication: requestOptions.authentication,\n    params: { f: \"json\" }\n  });\n\n  return removeItemResponse;\n}\n"]}

package/dist/esm/deleteOAuthApp.d.ts

@@ -1,27 +0,0 @@
-import { IDeleteOAuthAppOption, IDeleteOAuthAppResponse } from "./shared/types/oAuthType.js";
-/**
- * Used to delete the OAuth2.0 app with given `itemId`.
- *
- * ```js
- * import { deleteOAuthApp, IDeleteOAuthAppResponse } from '@esri/arcgis-rest-developer-credentials';
- * import { ArcGISIdentityManager } from "@esri/arcgis-rest-request";
- *
- * const authSession: ArcGISIdentityManager = await ArcGISIdentityManager.signIn({
- *   username: "xyz_usrName",
- *   password: "xyz_pw"
- * });
- *
- * deleteOAuthApp({
- *   itemId: "xyz_itemId",
- *   authentication: authSession
- * }).then((deletedOAuthApp: IDeleteOAuthAppResponse) => {
- *   // => {itemId: "xyz_itemId", success: true}
- * }).catch(e => {
- *   // => an exception object
- * });
- * ```
- *
- * @param requestOptions - Options for {@linkcode deleteOAuthApp | deleteOAuthApp()}, including `itemId` of which OAuth app to be deleted and an {@linkcode ArcGISIdentityManager} authentication session.
- * @returns A Promise that will resolve to an {@linkcode IDeleteOAuthAppResponse} object representing deletion status.
- */
-export declare function deleteOAuthApp(requestOptions: IDeleteOAuthAppOption): Promise<IDeleteOAuthAppResponse>;

package/dist/esm/deleteOAuthApp.js

@@ -1,39 +0,0 @@
-/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.
- * Apache-2.0 */
-import { removeItem } from "@esri/arcgis-rest-portal";
-import { extractBaseRequestOptions } from "./shared/helpers.js";
-import { getOAuthApp } from "./getOAuthApp.js";
-/**
- * Used to delete the OAuth2.0 app with given `itemId`.
- *
- * ```js
- * import { deleteOAuthApp, IDeleteOAuthAppResponse } from '@esri/arcgis-rest-developer-credentials';
- * import { ArcGISIdentityManager } from "@esri/arcgis-rest-request";
- *
- * const authSession: ArcGISIdentityManager = await ArcGISIdentityManager.signIn({
- *   username: "xyz_usrName",
- *   password: "xyz_pw"
- * });
- *
- * deleteOAuthApp({
- *   itemId: "xyz_itemId",
- *   authentication: authSession
- * }).then((deletedOAuthApp: IDeleteOAuthAppResponse) => {
- *   // => {itemId: "xyz_itemId", success: true}
- * }).catch(e => {
- *   // => an exception object
- * });
- * ```
- *
- * @param requestOptions - Options for {@linkcode deleteOAuthApp | deleteOAuthApp()}, including `itemId` of which OAuth app to be deleted and an {@linkcode ArcGISIdentityManager} authentication session.
- * @returns A Promise that will resolve to an {@linkcode IDeleteOAuthAppResponse} object representing deletion status.
- */
-export async function deleteOAuthApp(requestOptions) {
-    requestOptions.httpMethod = "POST";
-    const baseRequestOptions = extractBaseRequestOptions(requestOptions);
-    // validate provided itemId associates with OAuth app
-    await getOAuthApp(Object.assign(Object.assign({}, baseRequestOptions), { itemId: requestOptions.itemId, authentication: requestOptions.authentication }));
-    const removeItemResponse = await removeItem(Object.assign(Object.assign({}, baseRequestOptions), { id: requestOptions.itemId, authentication: requestOptions.authentication, params: { f: "json" } }));
-    return removeItemResponse;
-}
-//# sourceMappingURL=deleteOAuthApp.js.map

package/dist/esm/deleteOAuthApp.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"deleteOAuthApp.js","sourceRoot":"","sources":["../../src/deleteOAuthApp.ts"],"names":[],"mappings":"AAAA;gBACgB;AAEhB,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAEtD,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAKhE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,cAAqC;IAErC,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC;IAEnC,MAAM,kBAAkB,GAAG,yBAAyB,CAAC,cAAc,CAAC,CAAC;IAErE,qDAAqD;IACrD,MAAM,WAAW,iCACZ,kBAAkB,KACrB,MAAM,EAAE,cAAc,CAAC,MAAM,EAC7B,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH,MAAM,kBAAkB,GAA4B,MAAM,UAAU,iCAC/D,kBAAkB,KACrB,EAAE,EAAE,cAAc,CAAC,MAAM,EACzB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,IACrB,CAAC;IAEH,OAAO,kBAAkB,CAAC;AAC5B,CAAC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport { removeItem } from \"@esri/arcgis-rest-portal\";\n\nimport { extractBaseRequestOptions } from \"./shared/helpers.js\";\nimport {\n  IDeleteOAuthAppOption,\n  IDeleteOAuthAppResponse\n} from \"./shared/types/oAuthType.js\";\nimport { getOAuthApp } from \"./getOAuthApp.js\";\n\n/**\n * Used to delete the OAuth2.0 app with given `itemId`.\n *\n * ```js\n * import { deleteOAuthApp, IDeleteOAuthAppResponse } from '@esri/arcgis-rest-developer-credentials';\n * import { ArcGISIdentityManager } from \"@esri/arcgis-rest-request\";\n *\n * const authSession: ArcGISIdentityManager = await ArcGISIdentityManager.signIn({\n *   username: \"xyz_usrName\",\n *   password: \"xyz_pw\"\n * });\n *\n * deleteOAuthApp({\n *   itemId: \"xyz_itemId\",\n *   authentication: authSession\n * }).then((deletedOAuthApp: IDeleteOAuthAppResponse) => {\n *   // => {itemId: \"xyz_itemId\", success: true}\n * }).catch(e => {\n *   // => an exception object\n * });\n * ```\n *\n * @param requestOptions - Options for {@linkcode deleteOAuthApp | deleteOAuthApp()}, including `itemId` of which OAuth app to be deleted and an {@linkcode ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IDeleteOAuthAppResponse} object representing deletion status.\n */\nexport async function deleteOAuthApp(\n  requestOptions: IDeleteOAuthAppOption\n): Promise<IDeleteOAuthAppResponse> {\n  requestOptions.httpMethod = \"POST\";\n\n  const baseRequestOptions = extractBaseRequestOptions(requestOptions);\n\n  // validate provided itemId associates with OAuth app\n  await getOAuthApp({\n    ...baseRequestOptions,\n    itemId: requestOptions.itemId,\n    authentication: requestOptions.authentication\n  });\n\n  const removeItemResponse: IDeleteOAuthAppResponse = await removeItem({\n    ...baseRequestOptions,\n    id: requestOptions.itemId,\n    authentication: requestOptions.authentication,\n    params: { f: \"json\" }\n  });\n\n  return removeItemResponse;\n}\n"]}