@esri/arcgis-rest-developer-credentials 2.1.1-alpha.1 → 4.9.0

package/dist/cjs/shared/unregisterApp.js.map

@@ -1 +1 @@
-{"version":3,"file":"unregisterApp.js","sourceRoot":"","sources":["../../../src/shared/unregisterApp.ts"],"names":[],"mappings":";;;AAKA,6CAAyD;AACzD,uEAAiE;AACjE,iEAAwD;AACxD,mEAAoD;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACI,KAAK,UAAU,aAAa,CACjC,cAAqC;IAErC,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC;IAEnC,UAAU;IACV,MAAM,kBAAkB,GAAG,IAAA,sCAAyB,EAAC,cAAc,CAAC,CAAC;IACrE,MAAM,YAAY,mCACb,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE,cAAc,CAAC,MAAM,GAC9B,CAAC;IAEF,MAAM,WAAW,GAAG,MAAM,IAAA,8CAAoB,EAAC,YAAY,CAAC,CAAC;IAE7D,MAAM,QAAQ,GAAG,WAAW,CAAC,SAAS,CAAC;IAEvC,MAAM,GAAG,GACP,IAAA,iCAAY,EAAC,cAAc,CAAC,GAAG,gBAAgB,QAAQ,aAAa,CAAC;IAEvE,MAAM,qBAAqB,GAA2B,MAAM,IAAA,6BAAO,EAAC,GAAG,kCAClE,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,IACrB,CAAC;IACH,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AA1BD,sCA0BC","sourcesContent":["import {\n  IGetAppInfoOptions,\n  IUnregisterAppOptions,\n  IUnregisterAppResponse\n} from \"./types/appType.js\";\nimport { extractBaseRequestOptions } from \"./helpers.js\";\nimport { getRegisteredAppInfo } from \"./getRegisteredAppInfo.js\";\nimport { getPortalUrl } from \"@esri/arcgis-rest-portal\";\nimport { request } from \"@esri/arcgis-rest-request\";\n\n/**\n * Used to unregister the app with given `itemId`. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/unregister-app.htm) for more information.\n *\n * ```js\n * import { unregisterApp, IUnregisterAppResponse } 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 * unregisterApp({\n *   itemId: \"xyz_itemId\",\n *   authentication: authSession\n * }).then((unregisteredApp: IUnregisterAppResponse) => {\n *   // => {itemId: \"xyz_itemId\", success: true}\n * }).catch(e => {\n *   // => an exception object\n * });\n * ```\n *\n * @param requestOptions - Options for {@linkcode unregisterApp | unregisterApp()}, including `itemId` of which app to be un-registered and an {@linkcode ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IUnregisterAppResponse} object representing un-registration status.\n */\nexport async function unregisterApp(\n  requestOptions: IUnregisterAppOptions\n): Promise<IUnregisterAppResponse> {\n  requestOptions.httpMethod = \"POST\";\n\n  // get app\n  const baseRequestOptions = extractBaseRequestOptions(requestOptions);\n  const getAppOption: IGetAppInfoOptions = {\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication,\n    itemId: requestOptions.itemId\n  };\n\n  const appResponse = await getRegisteredAppInfo(getAppOption);\n\n  const clientId = appResponse.client_id;\n\n  const url =\n    getPortalUrl(requestOptions) + `/oauth2/apps/${clientId}/unregister`;\n\n  const unregisterAppResponse: IUnregisterAppResponse = await request(url, {\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication,\n    params: { f: \"json\" }\n  });\n  return unregisterAppResponse;\n}\n"]}
+{"version":3,"file":"unregisterApp.js","sourceRoot":"","sources":["../../../src/shared/unregisterApp.ts"],"names":[],"mappings":";;AAmCA,sCA0BC;AAxDD,6CAAyD;AACzD,uEAAiE;AACjE,iEAAwD;AACxD,mEAAoD;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACI,KAAK,UAAU,aAAa,CACjC,cAAqC;IAErC,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC;IAEnC,UAAU;IACV,MAAM,kBAAkB,GAAG,IAAA,sCAAyB,EAAC,cAAc,CAAC,CAAC;IACrE,MAAM,YAAY,mCACb,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE,cAAc,CAAC,MAAM,GAC9B,CAAC;IAEF,MAAM,WAAW,GAAG,MAAM,IAAA,8CAAoB,EAAC,YAAY,CAAC,CAAC;IAE7D,MAAM,QAAQ,GAAG,WAAW,CAAC,SAAS,CAAC;IAEvC,MAAM,GAAG,GACP,IAAA,iCAAY,EAAC,cAAc,CAAC,GAAG,gBAAgB,QAAQ,aAAa,CAAC;IAEvE,MAAM,qBAAqB,GAA2B,MAAM,IAAA,6BAAO,EAAC,GAAG,kCAClE,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,IACrB,CAAC;IACH,OAAO,qBAAqB,CAAC;AAC/B,CAAC","sourcesContent":["import {\n  IGetAppInfoOptions,\n  IUnregisterAppOptions,\n  IUnregisterAppResponse\n} from \"./types/appType.js\";\nimport { extractBaseRequestOptions } from \"./helpers.js\";\nimport { getRegisteredAppInfo } from \"./getRegisteredAppInfo.js\";\nimport { getPortalUrl } from \"@esri/arcgis-rest-portal\";\nimport { request } from \"@esri/arcgis-rest-request\";\n\n/**\n * Used to unregister the app with given `itemId`. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/unregister-app.htm) for more information.\n *\n * ```js\n * import { unregisterApp, IUnregisterAppResponse } 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 * unregisterApp({\n *   itemId: \"xyz_itemId\",\n *   authentication: authSession\n * }).then((unregisteredApp: IUnregisterAppResponse) => {\n *   // => {itemId: \"xyz_itemId\", success: true}\n * }).catch(e => {\n *   // => an exception object\n * });\n * ```\n *\n * @param requestOptions - Options for {@linkcode unregisterApp | unregisterApp()}, including `itemId` of which app to be un-registered and an {@linkcode @esri/arcgis-rest-request!ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IUnregisterAppResponse} object representing un-registration status.\n */\nexport async function unregisterApp(\n  requestOptions: IUnregisterAppOptions\n): Promise<IUnregisterAppResponse> {\n  requestOptions.httpMethod = \"POST\";\n\n  // get app\n  const baseRequestOptions = extractBaseRequestOptions(requestOptions);\n  const getAppOption: IGetAppInfoOptions = {\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication,\n    itemId: requestOptions.itemId\n  };\n\n  const appResponse = await getRegisteredAppInfo(getAppOption);\n\n  const clientId = appResponse.client_id;\n\n  const url =\n    getPortalUrl(requestOptions) + `/oauth2/apps/${clientId}/unregister`;\n\n  const unregisterAppResponse: IUnregisterAppResponse = await request(url, {\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication,\n    params: { f: \"json\" }\n  });\n  return unregisterAppResponse;\n}\n"]}

package/dist/cjs/updateApiKey.js

@@ -2,7 +2,7 @@
 /* Copyright (c) 2023 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateApiKey = void 0;
+exports.updateApiKey = updateApiKey;
 const getRegisteredAppInfo_js_1 = require("./shared/getRegisteredAppInfo.js");
 const helpers_js_1 = require("./shared/helpers.js");
 const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
@@ -41,7 +41,7 @@ const arcgis_rest_request_1 = require("@esri/arcgis-rest-request");
  * });
  * ```
  *
- * @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.
+ * @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 @esri/arcgis-rest-request!ArcGISIdentityManager} authentication session.
  * @returns A Promise that will resolve to an {@linkcode IApiKeyResponse} object representing updated API key.
  */
 async function updateApiKey(requestOptions) {
@@ -86,5 +86,4 @@ async function updateApiKey(requestOptions) {
     const updatedRegisteredAppResponse = await (0, getRegisteredAppInfo_js_1.getRegisteredAppInfo)(Object.assign(Object.assign({}, baseRequestOptions), { itemId: requestOptions.itemId, authentication: requestOptions.authentication }));
     return Object.assign(Object.assign(Object.assign({}, generatedTokens), (0, helpers_js_1.appToApiKeyProperties)(updatedRegisteredAppResponse)), { item: updatedItemInfo });
 }
-exports.updateApiKey = updateApiKey;
 //# sourceMappingURL=updateApiKey.js.map

package/dist/cjs/updateApiKey.js.map

@@ -1 +1 @@
-{"version":3,"file":"updateApiKey.js","sourceRoot":"","sources":["../../src/updateApiKey.ts"],"names":[],"mappings":";AAAA;gBACgB;;;AAMhB,8EAAwE;AACxE,oDAQ6B;AAC7B,iEAA6E;AAC7E,mEAAwE;AAOxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACI,KAAK,UAAU,YAAY,CAChC,cAAoC;IAEpC,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC;IACnC,MAAM,kBAAkB,GAAG,IAAA,sCAAyB,EAAC,cAAc,CAAC,CAAC,CAAC,mCAAmC;IAEzG;;OAEG;IACH,IACE,cAAc,CAAC,uBAAuB;QACtC,cAAc,CAAC,uBAAuB,EACtC;QACA,MAAM,YAAY,GAAG,IAAA,sCAAyB,EAAC,cAAc,CAAC,CAAC;QAC/D,MAAM,IAAA,+BAAU,kCACX,kBAAkB,KACrB,IAAI,kBACF,EAAE,EAAE,cAAc,CAAC,MAAM,IACtB,YAAY,GAEjB,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;KACJ;IAED;;OAEG;IACH,IAAI,cAAc,CAAC,UAAU,IAAI,cAAc,CAAC,aAAa,EAAE;QAC7D,MAAM,YAAY,mCACb,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE,cAAc,CAAC,MAAM,GAC9B,CAAC;QACF,MAAM,WAAW,GAAG,MAAM,IAAA,8CAAoB,EAAC,YAAY,CAAC,CAAC;QAC7D,MAAM,QAAQ,GAAG,WAAW,CAAC,SAAS,CAAC;QACvC,MAAM,OAAO,GAAG,IAAA,wCAAkB,kCAC3B,WAAW,GAAK,cAAc,GAAI,2CAA2C;QAClF,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,4CAA4C;SAC7E,CAAC;QACF,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC;QAE1B,mHAAmH;QACnH,IAAA,4BAAe,EAAC,OAAO,CAAC,CAAC;QAEzB,MAAM,GAAG,GAAG,IAAA,iCAAY,EAAC,OAAO,CAAC,GAAG,gBAAgB,QAAQ,SAAS,CAAC;QAEtE,gGAAgG;QAChG,MAAM,cAAc,GAA2B,MAAM,IAAA,6BAAO,EAAC,GAAG,kCAC3D,OAAO,KACV,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;KACJ;IAED;;OAEG;IACH,MAAM,eAAe,GAAG,MAAM,IAAA,4BAAO,EAAC,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,IAAA,iCAAoB,EAChD,cAAc,CAAC,MAAM,EACrB,IAAA,mCAAsB,EACpB,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,IAAA,8CAAoB,kCAC1D,kBAAkB,KACrB,MAAM,EAAE,cAAc,CAAC,MAAM,EAC7B,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH,qDACK,eAAe,GACf,IAAA,kCAAqB,EAAC,4BAA4B,CAAC,KACtD,IAAI,EAAE,eAAe,IACrB;AACJ,CAAC;AA3FD,oCA2FC","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 * const threeDaysFromToday = new Date();\n * threeDaysFromToday.setDate(threeDaysFromToday.getDate() + 3);\n * threeDaysFromToday.setHours(23, 59, 59, 999);\n *\n * updateApiKey({\n *   itemId: \"xyz_itemId\",\n *   privileges: [\"premium:user:geocode:temporary\"],\n *   httpReferrers: [], // httpReferrers will be set to be empty\n *   authentication: authSession\n *   generateToken1: true, // optional,generate a new token\n *   apiToken1ExpirationDate: threeDaysFromToday  // optional, update expiration date\n * }).then((updatedAPIKey: IApiKeyResponse) => {\n *   // => {accessToken1: \"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  if (requestOptions.privileges || requestOptions.httpReferrers) {\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  /**\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"]}
+{"version":3,"file":"updateApiKey.js","sourceRoot":"","sources":["../../src/updateApiKey.ts"],"names":[],"mappings":";AAAA;gBACgB;;AA6DhB,oCA2FC;AAlJD,8EAAwE;AACxE,oDAQ6B;AAC7B,iEAA6E;AAC7E,mEAAwE;AAOxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACI,KAAK,UAAU,YAAY,CAChC,cAAoC;IAEpC,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC;IACnC,MAAM,kBAAkB,GAAG,IAAA,sCAAyB,EAAC,cAAc,CAAC,CAAC,CAAC,mCAAmC;IAEzG;;OAEG;IACH,IACE,cAAc,CAAC,uBAAuB;QACtC,cAAc,CAAC,uBAAuB,EACtC,CAAC;QACD,MAAM,YAAY,GAAG,IAAA,sCAAyB,EAAC,cAAc,CAAC,CAAC;QAC/D,MAAM,IAAA,+BAAU,kCACX,kBAAkB,KACrB,IAAI,kBACF,EAAE,EAAE,cAAc,CAAC,MAAM,IACtB,YAAY,GAEjB,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IACL,CAAC;IAED;;OAEG;IACH,IAAI,cAAc,CAAC,UAAU,IAAI,cAAc,CAAC,aAAa,EAAE,CAAC;QAC9D,MAAM,YAAY,mCACb,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE,cAAc,CAAC,MAAM,GAC9B,CAAC;QACF,MAAM,WAAW,GAAG,MAAM,IAAA,8CAAoB,EAAC,YAAY,CAAC,CAAC;QAC7D,MAAM,QAAQ,GAAG,WAAW,CAAC,SAAS,CAAC;QACvC,MAAM,OAAO,GAAG,IAAA,wCAAkB,kCAC3B,WAAW,GAAK,cAAc,GAAI,2CAA2C;QAClF,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,4CAA4C;SAC7E,CAAC;QACF,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC;QAE1B,mHAAmH;QACnH,IAAA,4BAAe,EAAC,OAAO,CAAC,CAAC;QAEzB,MAAM,GAAG,GAAG,IAAA,iCAAY,EAAC,OAAO,CAAC,GAAG,gBAAgB,QAAQ,SAAS,CAAC;QAEtE,gGAAgG;QAChG,MAAM,cAAc,GAA2B,MAAM,IAAA,6BAAO,EAAC,GAAG,kCAC3D,OAAO,KACV,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,eAAe,GAAG,MAAM,IAAA,4BAAO,EAAC,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,IAAA,iCAAoB,EAChD,cAAc,CAAC,MAAM,EACrB,IAAA,mCAAsB,EACpB,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,IAAA,8CAAoB,kCAC1D,kBAAkB,KACrB,MAAM,EAAE,cAAc,CAAC,MAAM,EAC7B,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH,qDACK,eAAe,GACf,IAAA,kCAAqB,EAAC,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 * const threeDaysFromToday = new Date();\n * threeDaysFromToday.setDate(threeDaysFromToday.getDate() + 3);\n * threeDaysFromToday.setHours(23, 59, 59, 999);\n *\n * updateApiKey({\n *   itemId: \"xyz_itemId\",\n *   privileges: [\"premium:user:geocode:temporary\"],\n *   httpReferrers: [], // httpReferrers will be set to be empty\n *   authentication: authSession\n *   generateToken1: true, // optional,generate a new token\n *   apiToken1ExpirationDate: threeDaysFromToday  // optional, update expiration date\n * }).then((updatedAPIKey: IApiKeyResponse) => {\n *   // => {accessToken1: \"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 @esri/arcgis-rest-request!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  if (requestOptions.privileges || requestOptions.httpReferrers) {\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  /**\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/dist/cjs/updateOAuthApp.js

@@ -2,7 +2,7 @@
 /* Copyright (c) 2023 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateOAuthApp = void 0;
+exports.updateOAuthApp = updateOAuthApp;
 const helpers_js_1 = require("./shared/helpers.js");
 const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
 const arcgis_rest_request_1 = require("@esri/arcgis-rest-request");
@@ -34,7 +34,7 @@ const getRegisteredAppInfo_js_1 = require("./shared/getRegisteredAppInfo.js");
  * });
  * ```
  *
- * @param requestOptions - Options for {@linkcode updateOAuthApp | updateOAuthApp()}, including `itemId` of which OAuth app to be operated on, optional new `redirect_uris` and an {@linkcode ArcGISIdentityManager} authentication session.
+ * @param requestOptions - Options for {@linkcode updateOAuthApp | updateOAuthApp()}, including `itemId` of which OAuth app to be operated on, optional new `redirect_uris` and an {@linkcode @esri/arcgis-rest-request!ArcGISIdentityManager} authentication session.
  * @returns A Promise that will resolve to an {@linkcode IOAuthApp} object representing updated OAuth app.
  */
 async function updateOAuthApp(requestOptions) {
@@ -61,5 +61,4 @@ async function updateOAuthApp(requestOptions) {
     const itemInfo = await (0, arcgis_rest_portal_1.getItem)(requestOptions.itemId, Object.assign(Object.assign({}, baseRequestOptions), { authentication: requestOptions.authentication, params: { f: "json" } }));
     return Object.assign(Object.assign({}, (0, helpers_js_1.appToOAuthAppProperties)(app)), { item: itemInfo });
 }
-exports.updateOAuthApp = updateOAuthApp;
 //# sourceMappingURL=updateOAuthApp.js.map

package/dist/cjs/updateOAuthApp.js.map

@@ -1 +1 @@
-{"version":3,"file":"updateOAuthApp.js","sourceRoot":"","sources":["../../src/updateOAuthApp.ts"],"names":[],"mappings":";AAAA;gBACgB;;;AAEhB,oDAK6B;AAC7B,iEAAiE;AACjE,mEAAwE;AAOxE,8EAAwE;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACI,KAAK,UAAU,cAAc,CAClC,cAAmC;IAEnC,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC;IAEnC,UAAU;IACV,MAAM,kBAAkB,GAAG,IAAA,sCAAyB,EAAC,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,IAAA,8CAAoB,EAAC,YAAY,CAAC,CAAC;IAE7D,IAAI,WAAW,CAAC,OAAO,KAAK,QAAQ,EAAE;QACpC,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;KAClD;IAED,MAAM,QAAQ,GAAG,WAAW,CAAC,SAAS,CAAC;IACvC,MAAM,OAAO,GAAG,IAAA,wCAAkB,kCAAM,WAAW,GAAK,cAAc,GAAI;QACxE,eAAe;KAChB,CAAC,CAAC;IACH,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC;IAC1B,OAAO,CAAC,MAAM,CAAC,OAAO,GAAG,UAAU,CAAC;IAEpC,mHAAmH;IACnH,IAAA,4BAAe,EAAC,OAAO,CAAC,CAAC;IAEzB,MAAM,GAAG,GAAG,IAAA,iCAAY,EAAC,OAAO,CAAC,GAAG,gBAAgB,QAAQ,SAAS,CAAC;IAEtE,uDAAuD;IACvD,MAAM,cAAc,GAA2B,MAAM,IAAA,6BAAO,EAAC,GAAG,kCAC3D,OAAO,KACV,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH,MAAM,GAAG,GAAS,IAAA,uCAA0B,EAAC,cAAc,CAAC,CAAC;IAE7D,MAAM,QAAQ,GAAG,MAAM,IAAA,4BAAO,EAAC,cAAc,CAAC,MAAM,kCAC/C,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,IACrB,CAAC;IAEH,uCACK,IAAA,oCAAuB,EAAC,GAAG,CAAC,KAC/B,IAAI,EAAE,QAAQ,IACd;AACJ,CAAC;AAjDD,wCAiDC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  extractBaseRequestOptions,\n  stringifyArrays,\n  registeredAppResponseToApp,\n  appToOAuthAppProperties\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\";\nimport { IOAuthApp, IUpdateOAuthOptions } from \"./shared/types/oAuthType.js\";\nimport { getRegisteredAppInfo } from \"./shared/getRegisteredAppInfo.js\";\n\n/**\n * Used to update an OAuth2.0 app.\n *\n * Notes about `redirect_uris` 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 { updateOAuthApp, IOAuthApp } 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 * updateOAuthApp({\n *   itemId: \"xyz_itemId\",\n *   authentication: authSession\n * }).then((updatedOAuthApp: IOAuthApp) => {\n *   // => This OAuth app will be not be updated because its redirect_uris is not provided.\n *   // => {redirect_uris: [\"http://localhost:3000/\"], item: {tags: [\"xyz_tag1\", \"xyz_tag2\"], ...}, ...}\n * }).catch(e => {\n *   // => an exception object\n * });\n * ```\n *\n * @param requestOptions - Options for {@linkcode updateOAuthApp | updateOAuthApp()}, including `itemId` of which OAuth app to be operated on, optional new `redirect_uris` and an {@linkcode ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IOAuthApp} object representing updated OAuth app.\n */\nexport async function updateOAuthApp(\n  requestOptions: IUpdateOAuthOptions\n): Promise<IOAuthApp> {\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  if (appResponse.appType === \"apikey\") {\n    throw new Error(\"Item is not an OAuth 2.0 app.\");\n  }\n\n  const clientId = appResponse.client_id;\n  const options = appendCustomParams({ ...appResponse, ...requestOptions }, [\n    \"redirect_uris\"\n  ]);\n  options.params.f = \"json\";\n  options.params.appType = \"multiple\";\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`.\n  const updateResponse: IRegisteredAppResponse = await request(url, {\n    ...options,\n    authentication: requestOptions.authentication\n  });\n\n  const app: IApp = registeredAppResponseToApp(updateResponse);\n\n  const itemInfo = await getItem(requestOptions.itemId, {\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication,\n    params: { f: \"json\" }\n  });\n\n  return {\n    ...appToOAuthAppProperties(app),\n    item: itemInfo\n  };\n}\n"]}
+{"version":3,"file":"updateOAuthApp.js","sourceRoot":"","sources":["../../src/updateOAuthApp.ts"],"names":[],"mappings":";AAAA;gBACgB;;AAgDhB,wCAiDC;AA/FD,oDAK6B;AAC7B,iEAAiE;AACjE,mEAAwE;AAOxE,8EAAwE;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACI,KAAK,UAAU,cAAc,CAClC,cAAmC;IAEnC,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC;IAEnC,UAAU;IACV,MAAM,kBAAkB,GAAG,IAAA,sCAAyB,EAAC,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,IAAA,8CAAoB,EAAC,YAAY,CAAC,CAAC;IAE7D,IAAI,WAAW,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;QACrC,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACnD,CAAC;IAED,MAAM,QAAQ,GAAG,WAAW,CAAC,SAAS,CAAC;IACvC,MAAM,OAAO,GAAG,IAAA,wCAAkB,kCAAM,WAAW,GAAK,cAAc,GAAI;QACxE,eAAe;KAChB,CAAC,CAAC;IACH,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC;IAC1B,OAAO,CAAC,MAAM,CAAC,OAAO,GAAG,UAAU,CAAC;IAEpC,mHAAmH;IACnH,IAAA,4BAAe,EAAC,OAAO,CAAC,CAAC;IAEzB,MAAM,GAAG,GAAG,IAAA,iCAAY,EAAC,OAAO,CAAC,GAAG,gBAAgB,QAAQ,SAAS,CAAC;IAEtE,uDAAuD;IACvD,MAAM,cAAc,GAA2B,MAAM,IAAA,6BAAO,EAAC,GAAG,kCAC3D,OAAO,KACV,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH,MAAM,GAAG,GAAS,IAAA,uCAA0B,EAAC,cAAc,CAAC,CAAC;IAE7D,MAAM,QAAQ,GAAG,MAAM,IAAA,4BAAO,EAAC,cAAc,CAAC,MAAM,kCAC/C,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,IACrB,CAAC;IAEH,uCACK,IAAA,oCAAuB,EAAC,GAAG,CAAC,KAC/B,IAAI,EAAE,QAAQ,IACd;AACJ,CAAC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  extractBaseRequestOptions,\n  stringifyArrays,\n  registeredAppResponseToApp,\n  appToOAuthAppProperties\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\";\nimport { IOAuthApp, IUpdateOAuthOptions } from \"./shared/types/oAuthType.js\";\nimport { getRegisteredAppInfo } from \"./shared/getRegisteredAppInfo.js\";\n\n/**\n * Used to update an OAuth2.0 app.\n *\n * Notes about `redirect_uris` 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 { updateOAuthApp, IOAuthApp } 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 * updateOAuthApp({\n *   itemId: \"xyz_itemId\",\n *   authentication: authSession\n * }).then((updatedOAuthApp: IOAuthApp) => {\n *   // => This OAuth app will be not be updated because its redirect_uris is not provided.\n *   // => {redirect_uris: [\"http://localhost:3000/\"], item: {tags: [\"xyz_tag1\", \"xyz_tag2\"], ...}, ...}\n * }).catch(e => {\n *   // => an exception object\n * });\n * ```\n *\n * @param requestOptions - Options for {@linkcode updateOAuthApp | updateOAuthApp()}, including `itemId` of which OAuth app to be operated on, optional new `redirect_uris` and an {@linkcode @esri/arcgis-rest-request!ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IOAuthApp} object representing updated OAuth app.\n */\nexport async function updateOAuthApp(\n  requestOptions: IUpdateOAuthOptions\n): Promise<IOAuthApp> {\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  if (appResponse.appType === \"apikey\") {\n    throw new Error(\"Item is not an OAuth 2.0 app.\");\n  }\n\n  const clientId = appResponse.client_id;\n  const options = appendCustomParams({ ...appResponse, ...requestOptions }, [\n    \"redirect_uris\"\n  ]);\n  options.params.f = \"json\";\n  options.params.appType = \"multiple\";\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`.\n  const updateResponse: IRegisteredAppResponse = await request(url, {\n    ...options,\n    authentication: requestOptions.authentication\n  });\n\n  const app: IApp = registeredAppResponseToApp(updateResponse);\n\n  const itemInfo = await getItem(requestOptions.itemId, {\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication,\n    params: { f: \"json\" }\n  });\n\n  return {\n    ...appToOAuthAppProperties(app),\n    item: itemInfo\n  };\n}\n"]}

package/dist/esm/createApiKey.d.ts

@@ -30,7 +30,7 @@ import { IApiKeyResponse, ICreateApiKeyOptions } from "./shared/types/apiKeyType
  * });
  * ```
  *
- * @param requestOptions - Options for {@linkcode createApiKey | createApiKey()}, including necessary params to register an API key and an {@linkcode ArcGISIdentityManager} authentication session.
+ * @param requestOptions - Options for {@linkcode createApiKey | createApiKey()}, including necessary params to register an API key and an {@linkcode @esri/arcgis-rest-request!ArcGISIdentityManager} authentication session.
  * @returns A Promise that will resolve to an {@linkcode IApiKeyResponse} object representing the newly registered API key.
  */
 export declare function createApiKey(requestOptions: ICreateApiKeyOptions): Promise<IApiKeyResponse>;

package/dist/esm/createApiKey.js

@@ -35,7 +35,7 @@ import { getRegisteredAppInfo } from "./shared/getRegisteredAppInfo.js";
  * });
  * ```
  *
- * @param requestOptions - Options for {@linkcode createApiKey | createApiKey()}, including necessary params to register an API key and an {@linkcode ArcGISIdentityManager} authentication session.
+ * @param requestOptions - Options for {@linkcode createApiKey | createApiKey()}, including necessary params to register an API key and an {@linkcode @esri/arcgis-rest-request!ArcGISIdentityManager} authentication session.
  * @returns A Promise that will resolve to an {@linkcode IApiKeyResponse} object representing the newly registered API key.
  */
 export async function createApiKey(requestOptions) {

package/dist/esm/createApiKey.js.map

@@ -1 +1 @@
-{"version":3,"file":"createApiKey.js","sourceRoot":"","sources":["../../src/createApiKey.ts"],"names":[],"mappings":"AAAA;gBACgB;AAEhB,OAAO,EAEL,UAAU,EACV,OAAO,EAEP,UAAU,EACX,MAAM,0BAA0B,CAAC;AAMlC,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEtD,OAAO,EACL,qBAAqB,EACrB,UAAU,EACV,yBAAyB,EACzB,oBAAoB,EACpB,sBAAsB,EACtB,yBAAyB,EAC1B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,cAAoC;IAEpC,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC;IAEnC,wBAAwB;IACxB,MAAM,kBAAkB,GAAG,yBAAyB,CAAC,cAAc,CAAC,CAAC,CAAC,iFAAiF;IAEvJ,MAAM,iBAAiB,GAA0B;QAC/C,YAAY;QACZ,SAAS;QACT,aAAa;QACb,eAAe;QACf,QAAQ;QACR,OAAO;QACP,YAAY;QACZ,SAAS;QACT,kBAAkB;QAClB,MAAM;QACN,OAAO;QACP,MAAM;QACN,cAAc;QACd,KAAK;KACN,CAAC;IAEF;;OAEG;IACH,MAAM,gBAAgB,iCACpB,IAAI,kCACC,UAAU,CAAC,cAAqB,EAAE,iBAAiB,CAAC,KACvD,IAAI,EAAE,aAAa,OAElB,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE;YACN,CAAC,EAAE,MAAM;SACV,GACF,CAAC;IAEF,MAAM,kBAAkB,GAAG,MAAM,UAAU,CAAC,gBAAgB,CAAC,CAAC;IAE9D;;OAEG;IACH,MAAM,kBAAkB,iCACtB,MAAM,EAAE,kBAAkB,CAAC,EAAE,EAC7B,OAAO,EAAE,UAAU,EACnB,aAAa,EAAE,CAAC,2BAA2B,CAAC,EAC5C,aAAa,EAAE,cAAc,CAAC,aAAa,IAAI,EAAE,EACjD,UAAU,EAAE,cAAc,CAAC,UAAU,IAClC,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,GAC9C,CAAC;IAEF,MAAM,qBAAqB,GAAG,MAAM,WAAW,CAAC,kBAAkB,CAAC,CAAC;IAEpE;;;;OAIG;IACH,MAAM,UAAU,iCACX,kBAAkB,KACrB,IAAI,kBACF,EAAE,EAAE,kBAAkB,CAAC,EAAE,IACtB,yBAAyB,CAAC,cAAc,EAAE,IAAI,CAAC,GAEpD,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH;;OAEG;IACH,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,qBAAqB,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,QAAQ,CAAC,EAAE,EACX,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,QAAQ,CAAC,EAAE,EACnB,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH,qDACK,eAAe,GACf,qBAAqB,CAAC,4BAA4B,CAAC,KACtD,IAAI,EAAE,QAAQ,IACd;AACJ,CAAC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  ICreateItemOptions,\n  createItem,\n  getItem,\n  IItemAdd,\n  updateItem\n} from \"@esri/arcgis-rest-portal\";\nimport {\n  IApiKeyResponse,\n  ICreateApiKeyOptions\n} from \"./shared/types/apiKeyType.js\";\n\nimport { registerApp } from \"./shared/registerApp.js\";\nimport { IRegisterAppOptions } from \"./shared/types/appType.js\";\nimport {\n  appToApiKeyProperties,\n  filterKeys,\n  extractBaseRequestOptions,\n  generateApiKeyTokens,\n  generateOptionsToSlots,\n  buildExpirationDateParams\n} from \"./shared/helpers.js\";\nimport { getRegisteredAppInfo } from \"./shared/getRegisteredAppInfo.js\";\n\n/**\n * Used to register an API key. See the [security and authentication](https://developers.arcgis.com/documentation/mapping-apis-and-services/security/api-keys/) for more information about API key.\n *\n * ```js\n * import { createApiKey, 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 * const threeDaysFromToday = new Date();\n * threeDaysFromToday.setDate(threeDaysFromToday.getDate() + 3);\n * threeDaysFromToday.setHours(23, 59, 59, 999);\n *\n * createApiKey({\n *   title: \"xyz_title\",\n *   description: \"xyz_desc\",\n *   tags: [\"xyz_tag1\", \"xyz_tag2\"],\n *   privileges: [\"premium:user:networkanalysis:routing\"],\n *   authentication: authSession,\n *   generateToken1: true, // optional,generate a new token\n *   apiToken1ExpirationDate: threeDaysFromToday  // optional, update expiration date\n * }).then((registeredAPIKey: IApiKeyResponse) => {\n *   // => {accessToken1: \"xyz_key\", item: {tags: [\"xyz_tag1\", \"xyz_tag2\"], ...}, ...}\n * }).catch(e => {\n *   // => an exception object\n * });\n * ```\n *\n * @param requestOptions - Options for {@linkcode createApiKey | createApiKey()}, including necessary params to register an API key and an {@linkcode ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IApiKeyResponse} object representing the newly registered API key.\n */\nexport async function createApiKey(\n  requestOptions: ICreateApiKeyOptions\n): Promise<IApiKeyResponse> {\n  requestOptions.httpMethod = \"POST\";\n\n  // filter param buckets:\n  const baseRequestOptions = extractBaseRequestOptions(requestOptions); // snapshot of basic IRequestOptions before customized params being built into it\n\n  const itemAddProperties: Array<keyof IItemAdd> = [\n    \"categories\",\n    \"culture\",\n    \"description\",\n    \"documentation\",\n    \"extent\",\n    \"owner\",\n    \"properties\",\n    \"snippet\",\n    \"spatialReference\",\n    \"tags\",\n    \"title\",\n    \"type\",\n    \"typeKeywords\",\n    \"url\"\n  ];\n\n  /**\n   * step 1: create item\n   */\n  const createItemOption: ICreateItemOptions = {\n    item: {\n      ...filterKeys(requestOptions as any, itemAddProperties),\n      type: \"Application\"\n    },\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication,\n    params: {\n      f: \"json\"\n    }\n  };\n\n  const createItemResponse = await createItem(createItemOption);\n\n  /**\n   * getRegisteredAppInfoRoute\n   */\n  const registerAppOptions: IRegisterAppOptions = {\n    itemId: createItemResponse.id,\n    appType: \"multiple\",\n    redirect_uris: [\"urn:ietf:wg:oauth:2.0:oob\"],\n    httpReferrers: requestOptions.httpReferrers || [],\n    privileges: requestOptions.privileges,\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication\n  };\n\n  const registeredAppResponse = await registerApp(registerAppOptions);\n\n  /**\n   * step 3: update item with desired expiration dates\n   * you cannot set the expiration date propierties until you\n   * regiester the app so this has to be a seperate step\n   */\n  await updateItem({\n    ...baseRequestOptions,\n    item: {\n      id: createItemResponse.id,\n      ...buildExpirationDateParams(requestOptions, true)\n    },\n    authentication: requestOptions.authentication\n  });\n\n  /*\n   * step 4: get item info\n   */\n  const itemInfo = await getItem(registeredAppResponse.itemId, {\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication,\n    params: { f: \"json\" }\n  });\n\n  /**\n   * step 5: generate tokens if requested\n   */\n  const generatedTokens = await generateApiKeyTokens(\n    itemInfo.id,\n    generateOptionsToSlots(\n      requestOptions.generateToken1,\n      requestOptions.generateToken2\n    ),\n    {\n      ...baseRequestOptions,\n      authentication: requestOptions.authentication\n    }\n  );\n\n  /**\n   * step 6: get registered app info to get updated active key status\n   */\n  const updatedRegisteredAppResponse = await getRegisteredAppInfo({\n    ...baseRequestOptions,\n    itemId: itemInfo.id,\n    authentication: requestOptions.authentication\n  });\n\n  return {\n    ...generatedTokens,\n    ...appToApiKeyProperties(updatedRegisteredAppResponse),\n    item: itemInfo\n  };\n}\n"]}
+{"version":3,"file":"createApiKey.js","sourceRoot":"","sources":["../../src/createApiKey.ts"],"names":[],"mappings":"AAAA;gBACgB;AAEhB,OAAO,EAEL,UAAU,EACV,OAAO,EAEP,UAAU,EACX,MAAM,0BAA0B,CAAC;AAMlC,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEtD,OAAO,EACL,qBAAqB,EACrB,UAAU,EACV,yBAAyB,EACzB,oBAAoB,EACpB,sBAAsB,EACtB,yBAAyB,EAC1B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,cAAoC;IAEpC,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC;IAEnC,wBAAwB;IACxB,MAAM,kBAAkB,GAAG,yBAAyB,CAAC,cAAc,CAAC,CAAC,CAAC,iFAAiF;IAEvJ,MAAM,iBAAiB,GAA0B;QAC/C,YAAY;QACZ,SAAS;QACT,aAAa;QACb,eAAe;QACf,QAAQ;QACR,OAAO;QACP,YAAY;QACZ,SAAS;QACT,kBAAkB;QAClB,MAAM;QACN,OAAO;QACP,MAAM;QACN,cAAc;QACd,KAAK;KACN,CAAC;IAEF;;OAEG;IACH,MAAM,gBAAgB,iCACpB,IAAI,kCACC,UAAU,CAAC,cAAqB,EAAE,iBAAiB,CAAC,KACvD,IAAI,EAAE,aAAa,OAElB,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE;YACN,CAAC,EAAE,MAAM;SACV,GACF,CAAC;IAEF,MAAM,kBAAkB,GAAG,MAAM,UAAU,CAAC,gBAAgB,CAAC,CAAC;IAE9D;;OAEG;IACH,MAAM,kBAAkB,iCACtB,MAAM,EAAE,kBAAkB,CAAC,EAAE,EAC7B,OAAO,EAAE,UAAU,EACnB,aAAa,EAAE,CAAC,2BAA2B,CAAC,EAC5C,aAAa,EAAE,cAAc,CAAC,aAAa,IAAI,EAAE,EACjD,UAAU,EAAE,cAAc,CAAC,UAAU,IAClC,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,GAC9C,CAAC;IAEF,MAAM,qBAAqB,GAAG,MAAM,WAAW,CAAC,kBAAkB,CAAC,CAAC;IAEpE;;;;OAIG;IACH,MAAM,UAAU,iCACX,kBAAkB,KACrB,IAAI,kBACF,EAAE,EAAE,kBAAkB,CAAC,EAAE,IACtB,yBAAyB,CAAC,cAAc,EAAE,IAAI,CAAC,GAEpD,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH;;OAEG;IACH,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,qBAAqB,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,QAAQ,CAAC,EAAE,EACX,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,QAAQ,CAAC,EAAE,EACnB,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH,qDACK,eAAe,GACf,qBAAqB,CAAC,4BAA4B,CAAC,KACtD,IAAI,EAAE,QAAQ,IACd;AACJ,CAAC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  ICreateItemOptions,\n  createItem,\n  getItem,\n  IItemAdd,\n  updateItem\n} from \"@esri/arcgis-rest-portal\";\nimport {\n  IApiKeyResponse,\n  ICreateApiKeyOptions\n} from \"./shared/types/apiKeyType.js\";\n\nimport { registerApp } from \"./shared/registerApp.js\";\nimport { IRegisterAppOptions } from \"./shared/types/appType.js\";\nimport {\n  appToApiKeyProperties,\n  filterKeys,\n  extractBaseRequestOptions,\n  generateApiKeyTokens,\n  generateOptionsToSlots,\n  buildExpirationDateParams\n} from \"./shared/helpers.js\";\nimport { getRegisteredAppInfo } from \"./shared/getRegisteredAppInfo.js\";\n\n/**\n * Used to register an API key. See the [security and authentication](https://developers.arcgis.com/documentation/mapping-apis-and-services/security/api-keys/) for more information about API key.\n *\n * ```js\n * import { createApiKey, 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 * const threeDaysFromToday = new Date();\n * threeDaysFromToday.setDate(threeDaysFromToday.getDate() + 3);\n * threeDaysFromToday.setHours(23, 59, 59, 999);\n *\n * createApiKey({\n *   title: \"xyz_title\",\n *   description: \"xyz_desc\",\n *   tags: [\"xyz_tag1\", \"xyz_tag2\"],\n *   privileges: [\"premium:user:networkanalysis:routing\"],\n *   authentication: authSession,\n *   generateToken1: true, // optional,generate a new token\n *   apiToken1ExpirationDate: threeDaysFromToday  // optional, update expiration date\n * }).then((registeredAPIKey: IApiKeyResponse) => {\n *   // => {accessToken1: \"xyz_key\", item: {tags: [\"xyz_tag1\", \"xyz_tag2\"], ...}, ...}\n * }).catch(e => {\n *   // => an exception object\n * });\n * ```\n *\n * @param requestOptions - Options for {@linkcode createApiKey | createApiKey()}, including necessary params to register an API key and an {@linkcode @esri/arcgis-rest-request!ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IApiKeyResponse} object representing the newly registered API key.\n */\nexport async function createApiKey(\n  requestOptions: ICreateApiKeyOptions\n): Promise<IApiKeyResponse> {\n  requestOptions.httpMethod = \"POST\";\n\n  // filter param buckets:\n  const baseRequestOptions = extractBaseRequestOptions(requestOptions); // snapshot of basic IRequestOptions before customized params being built into it\n\n  const itemAddProperties: Array<keyof IItemAdd> = [\n    \"categories\",\n    \"culture\",\n    \"description\",\n    \"documentation\",\n    \"extent\",\n    \"owner\",\n    \"properties\",\n    \"snippet\",\n    \"spatialReference\",\n    \"tags\",\n    \"title\",\n    \"type\",\n    \"typeKeywords\",\n    \"url\"\n  ];\n\n  /**\n   * step 1: create item\n   */\n  const createItemOption: ICreateItemOptions = {\n    item: {\n      ...filterKeys(requestOptions as any, itemAddProperties),\n      type: \"Application\"\n    },\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication,\n    params: {\n      f: \"json\"\n    }\n  };\n\n  const createItemResponse = await createItem(createItemOption);\n\n  /**\n   * getRegisteredAppInfoRoute\n   */\n  const registerAppOptions: IRegisterAppOptions = {\n    itemId: createItemResponse.id,\n    appType: \"multiple\",\n    redirect_uris: [\"urn:ietf:wg:oauth:2.0:oob\"],\n    httpReferrers: requestOptions.httpReferrers || [],\n    privileges: requestOptions.privileges,\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication\n  };\n\n  const registeredAppResponse = await registerApp(registerAppOptions);\n\n  /**\n   * step 3: update item with desired expiration dates\n   * you cannot set the expiration date propierties until you\n   * regiester the app so this has to be a seperate step\n   */\n  await updateItem({\n    ...baseRequestOptions,\n    item: {\n      id: createItemResponse.id,\n      ...buildExpirationDateParams(requestOptions, true)\n    },\n    authentication: requestOptions.authentication\n  });\n\n  /*\n   * step 4: get item info\n   */\n  const itemInfo = await getItem(registeredAppResponse.itemId, {\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication,\n    params: { f: \"json\" }\n  });\n\n  /**\n   * step 5: generate tokens if requested\n   */\n  const generatedTokens = await generateApiKeyTokens(\n    itemInfo.id,\n    generateOptionsToSlots(\n      requestOptions.generateToken1,\n      requestOptions.generateToken2\n    ),\n    {\n      ...baseRequestOptions,\n      authentication: requestOptions.authentication\n    }\n  );\n\n  /**\n   * step 6: get registered app info to get updated active key status\n   */\n  const updatedRegisteredAppResponse = await getRegisteredAppInfo({\n    ...baseRequestOptions,\n    itemId: itemInfo.id,\n    authentication: requestOptions.authentication\n  });\n\n  return {\n    ...generatedTokens,\n    ...appToApiKeyProperties(updatedRegisteredAppResponse),\n    item: itemInfo\n  };\n}\n"]}

package/dist/esm/createOAuthApp.d.ts

@@ -24,7 +24,7 @@ import { ICreateOAuthAppOption, IOAuthApp } from "./shared/types/oAuthType.js";
  * });
  * ```
  *
- * @param requestOptions - Options for {@linkcode createOAuthApp | createOAuthApp()}, including necessary params to register an OAuth app and an {@linkcode ArcGISIdentityManager} authentication session.
+ * @param requestOptions - Options for {@linkcode createOAuthApp | createOAuthApp()}, including necessary params to register an OAuth app and an {@linkcode @esri/arcgis-rest-request!ArcGISIdentityManager} authentication session.
  * @returns A Promise that will resolve to an {@linkcode IOAuthApp} object representing the newly registered OAuth app.
  */
 export declare function createOAuthApp(requestOptions: ICreateOAuthAppOption): Promise<IOAuthApp>;

package/dist/esm/createOAuthApp.js

@@ -28,7 +28,7 @@ import { filterKeys, extractBaseRequestOptions, appToOAuthAppProperties } from "
  * });
  * ```
  *
- * @param requestOptions - Options for {@linkcode createOAuthApp | createOAuthApp()}, including necessary params to register an OAuth app and an {@linkcode ArcGISIdentityManager} authentication session.
+ * @param requestOptions - Options for {@linkcode createOAuthApp | createOAuthApp()}, including necessary params to register an OAuth app and an {@linkcode @esri/arcgis-rest-request!ArcGISIdentityManager} authentication session.
  * @returns A Promise that will resolve to an {@linkcode IOAuthApp} object representing the newly registered OAuth app.
  */
 export async function createOAuthApp(requestOptions) {

package/dist/esm/createOAuthApp.js.map

@@ -1 +1 @@
-{"version":3,"file":"createOAuthApp.js","sourceRoot":"","sources":["../../src/createOAuthApp.ts"],"names":[],"mappings":"AAAA;gBACgB;AAEhB,OAAO,EAEL,UAAU,EACV,OAAO,EAER,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEtD,OAAO,EACL,UAAU,EACV,yBAAyB,EACzB,uBAAuB,EACxB,MAAM,qBAAqB,CAAC;AAG7B;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,cAAqC;IAErC,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC;IAEnC,wBAAwB;IAExB,MAAM,kBAAkB,GAAG,yBAAyB,CAAC,cAAc,CAAC,CAAC;IAErE,MAAM,iBAAiB,GAA0B;QAC/C,YAAY;QACZ,SAAS;QACT,aAAa;QACb,eAAe;QACf,QAAQ;QACR,OAAO;QACP,YAAY;QACZ,SAAS;QACT,kBAAkB;QAClB,MAAM;QACN,OAAO;QACP,MAAM;QACN,cAAc;QACd,KAAK;KACN,CAAC;IAEF,mBAAmB;IACnB,MAAM,gBAAgB,iCACpB,IAAI,kCACC,UAAU,CAAC,cAAqB,EAAE,iBAAiB,CAAC,KACvD,IAAI,EAAE,aAAa,OAElB,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE;YACN,CAAC,EAAE,MAAM;SACV,GACF,CAAC;IAEF,MAAM,kBAAkB,GAAG,MAAM,UAAU,CAAC,gBAAgB,CAAC,CAAC;IAE9D,uBAAuB;IACvB,MAAM,iBAAiB,iCACrB,MAAM,EAAE,kBAAkB,CAAC,EAAE,EAC7B,OAAO,EAAE,UAAU,EACnB,aAAa,EAAE,cAAc,CAAC,aAAa,IAAI,EAAE,EACjD,aAAa,EAAE,EAAE,EACjB,UAAU,EAAE,EAAE,IACX,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,GAC9C,CAAC;IAEF,MAAM,qBAAqB,GAAG,MAAM,WAAW,CAAC,iBAAiB,CAAC,CAAC;IACnE,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,qBAAqB,CAAC,MAAM,kCACtD,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,IACrB,CAAC;IAEH,uCACK,uBAAuB,CAAC,qBAAqB,CAAC,KACjD,IAAI,EAAE,QAAQ,IACd;AACJ,CAAC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  ICreateItemOptions,\n  createItem,\n  getItem,\n  IItemAdd\n} from \"@esri/arcgis-rest-portal\";\n\nimport { registerApp } from \"./shared/registerApp.js\";\nimport { IRegisterAppOptions } from \"./shared/types/appType.js\";\nimport {\n  filterKeys,\n  extractBaseRequestOptions,\n  appToOAuthAppProperties\n} from \"./shared/helpers.js\";\nimport { ICreateOAuthAppOption, IOAuthApp } from \"./shared/types/oAuthType.js\";\n\n/**\n * Used to register an OAuth2.0 app. See the [OAuth2.0](https://developers.arcgis.com/documentation/mapping-apis-and-services/security/oauth-2.0/) for more information.\n *\n * ```js\n * import { createOAuthApp, IOAuthApp } 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 * createOAuthApp({\n *   title: \"xyz_title\",\n *   description: \"xyz_desc\",\n *   tags: [\"xyz_tag1\", \"xyz_tag2\"],\n *   redirect_uris: [\"http://localhost:3000/\"],\n *   authentication: authSession\n * }).then((registeredOAuthApp: IOAuthApp) => {\n *   // => {redirect_uris: [\"http://localhost:3000/\"], item: {tags: [\"xyz_tag1\", \"xyz_tag2\"], ...}, ...}\n * }).catch(e => {\n *   // => an exception object\n * });\n * ```\n *\n * @param requestOptions - Options for {@linkcode createOAuthApp | createOAuthApp()}, including necessary params to register an OAuth app and an {@linkcode ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IOAuthApp} object representing the newly registered OAuth app.\n */\nexport async function createOAuthApp(\n  requestOptions: ICreateOAuthAppOption\n): Promise<IOAuthApp> {\n  requestOptions.httpMethod = \"POST\";\n\n  // filter param buckets:\n\n  const baseRequestOptions = extractBaseRequestOptions(requestOptions);\n\n  const itemAddProperties: Array<keyof IItemAdd> = [\n    \"categories\",\n    \"culture\",\n    \"description\",\n    \"documentation\",\n    \"extent\",\n    \"owner\",\n    \"properties\",\n    \"snippet\",\n    \"spatialReference\",\n    \"tags\",\n    \"title\",\n    \"type\",\n    \"typeKeywords\",\n    \"url\"\n  ];\n\n  // step 1: add item\n  const createItemOption: ICreateItemOptions = {\n    item: {\n      ...filterKeys(requestOptions as any, itemAddProperties),\n      type: \"Application\"\n    },\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication,\n    params: {\n      f: \"json\"\n    }\n  };\n\n  const createItemResponse = await createItem(createItemOption);\n\n  // step 2: register app\n  const registerAppOption: IRegisterAppOptions = {\n    itemId: createItemResponse.id,\n    appType: \"multiple\",\n    redirect_uris: requestOptions.redirect_uris || [],\n    httpReferrers: [],\n    privileges: [],\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication\n  };\n\n  const registeredAppResponse = await registerApp(registerAppOption);\n  const itemInfo = await getItem(registeredAppResponse.itemId, {\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication,\n    params: { f: \"json\" }\n  });\n\n  return {\n    ...appToOAuthAppProperties(registeredAppResponse),\n    item: itemInfo\n  };\n}\n"]}
+{"version":3,"file":"createOAuthApp.js","sourceRoot":"","sources":["../../src/createOAuthApp.ts"],"names":[],"mappings":"AAAA;gBACgB;AAEhB,OAAO,EAEL,UAAU,EACV,OAAO,EAER,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEtD,OAAO,EACL,UAAU,EACV,yBAAyB,EACzB,uBAAuB,EACxB,MAAM,qBAAqB,CAAC;AAG7B;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,cAAqC;IAErC,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC;IAEnC,wBAAwB;IAExB,MAAM,kBAAkB,GAAG,yBAAyB,CAAC,cAAc,CAAC,CAAC;IAErE,MAAM,iBAAiB,GAA0B;QAC/C,YAAY;QACZ,SAAS;QACT,aAAa;QACb,eAAe;QACf,QAAQ;QACR,OAAO;QACP,YAAY;QACZ,SAAS;QACT,kBAAkB;QAClB,MAAM;QACN,OAAO;QACP,MAAM;QACN,cAAc;QACd,KAAK;KACN,CAAC;IAEF,mBAAmB;IACnB,MAAM,gBAAgB,iCACpB,IAAI,kCACC,UAAU,CAAC,cAAqB,EAAE,iBAAiB,CAAC,KACvD,IAAI,EAAE,aAAa,OAElB,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE;YACN,CAAC,EAAE,MAAM;SACV,GACF,CAAC;IAEF,MAAM,kBAAkB,GAAG,MAAM,UAAU,CAAC,gBAAgB,CAAC,CAAC;IAE9D,uBAAuB;IACvB,MAAM,iBAAiB,iCACrB,MAAM,EAAE,kBAAkB,CAAC,EAAE,EAC7B,OAAO,EAAE,UAAU,EACnB,aAAa,EAAE,cAAc,CAAC,aAAa,IAAI,EAAE,EACjD,aAAa,EAAE,EAAE,EACjB,UAAU,EAAE,EAAE,IACX,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,GAC9C,CAAC;IAEF,MAAM,qBAAqB,GAAG,MAAM,WAAW,CAAC,iBAAiB,CAAC,CAAC;IACnE,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,qBAAqB,CAAC,MAAM,kCACtD,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,IACrB,CAAC;IAEH,uCACK,uBAAuB,CAAC,qBAAqB,CAAC,KACjD,IAAI,EAAE,QAAQ,IACd;AACJ,CAAC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  ICreateItemOptions,\n  createItem,\n  getItem,\n  IItemAdd\n} from \"@esri/arcgis-rest-portal\";\n\nimport { registerApp } from \"./shared/registerApp.js\";\nimport { IRegisterAppOptions } from \"./shared/types/appType.js\";\nimport {\n  filterKeys,\n  extractBaseRequestOptions,\n  appToOAuthAppProperties\n} from \"./shared/helpers.js\";\nimport { ICreateOAuthAppOption, IOAuthApp } from \"./shared/types/oAuthType.js\";\n\n/**\n * Used to register an OAuth2.0 app. See the [OAuth2.0](https://developers.arcgis.com/documentation/mapping-apis-and-services/security/oauth-2.0/) for more information.\n *\n * ```js\n * import { createOAuthApp, IOAuthApp } 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 * createOAuthApp({\n *   title: \"xyz_title\",\n *   description: \"xyz_desc\",\n *   tags: [\"xyz_tag1\", \"xyz_tag2\"],\n *   redirect_uris: [\"http://localhost:3000/\"],\n *   authentication: authSession\n * }).then((registeredOAuthApp: IOAuthApp) => {\n *   // => {redirect_uris: [\"http://localhost:3000/\"], item: {tags: [\"xyz_tag1\", \"xyz_tag2\"], ...}, ...}\n * }).catch(e => {\n *   // => an exception object\n * });\n * ```\n *\n * @param requestOptions - Options for {@linkcode createOAuthApp | createOAuthApp()}, including necessary params to register an OAuth app and an {@linkcode @esri/arcgis-rest-request!ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IOAuthApp} object representing the newly registered OAuth app.\n */\nexport async function createOAuthApp(\n  requestOptions: ICreateOAuthAppOption\n): Promise<IOAuthApp> {\n  requestOptions.httpMethod = \"POST\";\n\n  // filter param buckets:\n\n  const baseRequestOptions = extractBaseRequestOptions(requestOptions);\n\n  const itemAddProperties: Array<keyof IItemAdd> = [\n    \"categories\",\n    \"culture\",\n    \"description\",\n    \"documentation\",\n    \"extent\",\n    \"owner\",\n    \"properties\",\n    \"snippet\",\n    \"spatialReference\",\n    \"tags\",\n    \"title\",\n    \"type\",\n    \"typeKeywords\",\n    \"url\"\n  ];\n\n  // step 1: add item\n  const createItemOption: ICreateItemOptions = {\n    item: {\n      ...filterKeys(requestOptions as any, itemAddProperties),\n      type: \"Application\"\n    },\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication,\n    params: {\n      f: \"json\"\n    }\n  };\n\n  const createItemResponse = await createItem(createItemOption);\n\n  // step 2: register app\n  const registerAppOption: IRegisterAppOptions = {\n    itemId: createItemResponse.id,\n    appType: \"multiple\",\n    redirect_uris: requestOptions.redirect_uris || [],\n    httpReferrers: [],\n    privileges: [],\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication\n  };\n\n  const registeredAppResponse = await registerApp(registerAppOption);\n  const itemInfo = await getItem(registeredAppResponse.itemId, {\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication,\n    params: { f: \"json\" }\n  });\n\n  return {\n    ...appToOAuthAppProperties(registeredAppResponse),\n    item: itemInfo\n  };\n}\n"]}

package/dist/esm/getApiKey.d.ts

@@ -21,7 +21,7 @@ import { IApiKeyResponse, IGetApiKeyOptions } from "./shared/types/apiKeyType.js
  * });
  * ```
  *
- * @param requestOptions - Options for {@linkcode getApiKey | getApiKey()}, including `itemId` of which API key to retrieve and an {@linkcode ArcGISIdentityManager} authentication session.
+ * @param requestOptions - Options for {@linkcode getApiKey | getApiKey()}, including `itemId` of which API key to retrieve and an {@linkcode @esri/arcgis-rest-request!ArcGISIdentityManager} authentication session.
  * @returns A Promise that will resolve to an {@linkcode IApiKeyResponse} object representing successfully retrieved API key.
  */
 export declare function getApiKey(requestOptions: IGetApiKeyOptions): Promise<IApiKeyResponse>;

package/dist/esm/getApiKey.js

@@ -25,7 +25,7 @@ import { appToApiKeyProperties, extractBaseRequestOptions } from "./shared/helpe
  * });
  * ```
  *
- * @param requestOptions - Options for {@linkcode getApiKey | getApiKey()}, including `itemId` of which API key to retrieve and an {@linkcode ArcGISIdentityManager} authentication session.
+ * @param requestOptions - Options for {@linkcode getApiKey | getApiKey()}, including `itemId` of which API key to retrieve and an {@linkcode @esri/arcgis-rest-request!ArcGISIdentityManager} authentication session.
  * @returns A Promise that will resolve to an {@linkcode IApiKeyResponse} object representing successfully retrieved API key.
  */
 export async function getApiKey(requestOptions) {

package/dist/esm/getApiKey.js.map

@@ -1 +1 @@
-{"version":3,"file":"getApiKey.js","sourceRoot":"","sources":["../../src/getApiKey.ts"],"names":[],"mappings":"AAAA;gBACgB;AAEhB,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAKxE,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,EACL,qBAAqB,EACrB,yBAAyB,EAC1B,MAAM,qBAAqB,CAAC;AAE7B;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,cAAiC;IAEjC,MAAM,WAAW,GAAG,MAAM,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAE/D,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,MAAM,kCAC/C,yBAAyB,CAAC,cAAc,CAAC,KAC5C,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH,uCACK,qBAAqB,CAAC,WAAW,CAAC,KACrC,IAAI,EAAE,QAAQ,IACd;AACJ,CAAC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport { getRegisteredAppInfo } from \"./shared/getRegisteredAppInfo.js\";\nimport {\n  IApiKeyResponse,\n  IGetApiKeyOptions\n} from \"./shared/types/apiKeyType.js\";\nimport { getItem } from \"@esri/arcgis-rest-portal\";\nimport {\n  appToApiKeyProperties,\n  extractBaseRequestOptions\n} from \"./shared/helpers.js\";\n\n/**\n * Used to retrieve the API key with given `itemId`. See the [security and authentication](https://developers.arcgis.com/documentation/mapping-apis-and-services/security/api-keys/) for more information about API key.\n *\n * ```js\n * import { getApiKey, 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 * getApiKey({\n *   itemId: \"xyz_itemId\",\n *   authentication: authSession\n * }).then((retrievedAPIKey: 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 getApiKey | getApiKey()}, including `itemId` of which API key to retrieve and an {@linkcode ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IApiKeyResponse} object representing successfully retrieved API key.\n */\nexport async function getApiKey(\n  requestOptions: IGetApiKeyOptions\n): Promise<IApiKeyResponse> {\n  const appResponse = await getRegisteredAppInfo(requestOptions);\n\n  const itemInfo = await getItem(requestOptions.itemId, {\n    ...extractBaseRequestOptions(requestOptions),\n    authentication: requestOptions.authentication\n  });\n\n  return {\n    ...appToApiKeyProperties(appResponse),\n    item: itemInfo\n  };\n}\n"]}
+{"version":3,"file":"getApiKey.js","sourceRoot":"","sources":["../../src/getApiKey.ts"],"names":[],"mappings":"AAAA;gBACgB;AAEhB,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAKxE,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,EACL,qBAAqB,EACrB,yBAAyB,EAC1B,MAAM,qBAAqB,CAAC;AAE7B;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,cAAiC;IAEjC,MAAM,WAAW,GAAG,MAAM,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAE/D,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,MAAM,kCAC/C,yBAAyB,CAAC,cAAc,CAAC,KAC5C,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH,uCACK,qBAAqB,CAAC,WAAW,CAAC,KACrC,IAAI,EAAE,QAAQ,IACd;AACJ,CAAC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport { getRegisteredAppInfo } from \"./shared/getRegisteredAppInfo.js\";\nimport {\n  IApiKeyResponse,\n  IGetApiKeyOptions\n} from \"./shared/types/apiKeyType.js\";\nimport { getItem } from \"@esri/arcgis-rest-portal\";\nimport {\n  appToApiKeyProperties,\n  extractBaseRequestOptions\n} from \"./shared/helpers.js\";\n\n/**\n * Used to retrieve the API key with given `itemId`. See the [security and authentication](https://developers.arcgis.com/documentation/mapping-apis-and-services/security/api-keys/) for more information about API key.\n *\n * ```js\n * import { getApiKey, 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 * getApiKey({\n *   itemId: \"xyz_itemId\",\n *   authentication: authSession\n * }).then((retrievedAPIKey: 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 getApiKey | getApiKey()}, including `itemId` of which API key to retrieve and an {@linkcode @esri/arcgis-rest-request!ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IApiKeyResponse} object representing successfully retrieved API key.\n */\nexport async function getApiKey(\n  requestOptions: IGetApiKeyOptions\n): Promise<IApiKeyResponse> {\n  const appResponse = await getRegisteredAppInfo(requestOptions);\n\n  const itemInfo = await getItem(requestOptions.itemId, {\n    ...extractBaseRequestOptions(requestOptions),\n    authentication: requestOptions.authentication\n  });\n\n  return {\n    ...appToApiKeyProperties(appResponse),\n    item: itemInfo\n  };\n}\n"]}

package/dist/esm/getOAuthApp.d.ts

@@ -21,7 +21,7 @@ import { IGetOAuthAppOptions, IOAuthApp } from "./shared/types/oAuthType.js";
  * });
  * ```
  *
- * @param requestOptions - Options for {@linkcode getOAuthApp | getOAuthApp()}, including `itemId` of which OAuth app to retrieve and an {@linkcode ArcGISIdentityManager} authentication session.
+ * @param requestOptions - Options for {@linkcode getOAuthApp | getOAuthApp()}, including `itemId` of which OAuth app to retrieve and an {@linkcode @esri/arcgis-rest-request!ArcGISIdentityManager} authentication session.
  * @returns A Promise that will resolve to an {@linkcode IOAuthApp} object representing successfully retrieved OAuth app.
  */
 export declare function getOAuthApp(requestOptions: IGetOAuthAppOptions): Promise<IOAuthApp>;

package/dist/esm/getOAuthApp.js

@@ -25,7 +25,7 @@ import { appToOAuthAppProperties, extractBaseRequestOptions } from "./shared/hel
  * });
  * ```
  *
- * @param requestOptions - Options for {@linkcode getOAuthApp | getOAuthApp()}, including `itemId` of which OAuth app to retrieve and an {@linkcode ArcGISIdentityManager} authentication session.
+ * @param requestOptions - Options for {@linkcode getOAuthApp | getOAuthApp()}, including `itemId` of which OAuth app to retrieve and an {@linkcode @esri/arcgis-rest-request!ArcGISIdentityManager} authentication session.
  * @returns A Promise that will resolve to an {@linkcode IOAuthApp} object representing successfully retrieved OAuth app.
  */
 export async function getOAuthApp(requestOptions) {

package/dist/esm/getOAuthApp.js.map

@@ -1 +1 @@
-{"version":3,"file":"getOAuthApp.js","sourceRoot":"","sources":["../../src/getOAuthApp.ts"],"names":[],"mappings":"AAAA;gBACgB;AAEhB,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,EACL,uBAAuB,EACvB,yBAAyB,EAC1B,MAAM,qBAAqB,CAAC;AAG7B;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,cAAmC;IAEnC,MAAM,WAAW,GAAG,MAAM,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAE/D,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,MAAM,kCAC/C,yBAAyB,CAAC,cAAc,CAAC,KAC5C,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH,uCACK,uBAAuB,CAAC,WAAW,CAAC,KACvC,IAAI,EAAE,QAAQ,IACd;AACJ,CAAC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport { getRegisteredAppInfo } from \"./shared/getRegisteredAppInfo.js\";\nimport { getItem } from \"@esri/arcgis-rest-portal\";\nimport {\n  appToOAuthAppProperties,\n  extractBaseRequestOptions\n} from \"./shared/helpers.js\";\nimport { IGetOAuthAppOptions, IOAuthApp } from \"./shared/types/oAuthType.js\";\n\n/**\n * Used to retrieve the OAuth2.0 app with given `itemId`. See the [OAuth2.0](https://developers.arcgis.com/documentation/mapping-apis-and-services/security/oauth-2.0/) for more information.\n *\n * ```js\n * import { getOAuthApp, IOAuthApp } 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 * getOAuthApp({\n *   itemId: \"xyz_itemId\",\n *   authentication: authSession\n * }).then((retrievedOAuthApp: IOAuthApp) => {\n *   // => {redirect_uris: [\"http://localhost:3000/\"], item: {tags: [\"xyz_tag1\", \"xyz_tag2\"], ...}, ...}\n * }).catch(e => {\n *   // => an exception object\n * });\n * ```\n *\n * @param requestOptions - Options for {@linkcode getOAuthApp | getOAuthApp()}, including `itemId` of which OAuth app to retrieve and an {@linkcode ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IOAuthApp} object representing successfully retrieved OAuth app.\n */\nexport async function getOAuthApp(\n  requestOptions: IGetOAuthAppOptions\n): Promise<IOAuthApp> {\n  const appResponse = await getRegisteredAppInfo(requestOptions);\n\n  const itemInfo = await getItem(requestOptions.itemId, {\n    ...extractBaseRequestOptions(requestOptions),\n    authentication: requestOptions.authentication\n  });\n\n  return {\n    ...appToOAuthAppProperties(appResponse),\n    item: itemInfo\n  };\n}\n"]}
+{"version":3,"file":"getOAuthApp.js","sourceRoot":"","sources":["../../src/getOAuthApp.ts"],"names":[],"mappings":"AAAA;gBACgB;AAEhB,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,EACL,uBAAuB,EACvB,yBAAyB,EAC1B,MAAM,qBAAqB,CAAC;AAG7B;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,cAAmC;IAEnC,MAAM,WAAW,GAAG,MAAM,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAE/D,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,MAAM,kCAC/C,yBAAyB,CAAC,cAAc,CAAC,KAC5C,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH,uCACK,uBAAuB,CAAC,WAAW,CAAC,KACvC,IAAI,EAAE,QAAQ,IACd;AACJ,CAAC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport { getRegisteredAppInfo } from \"./shared/getRegisteredAppInfo.js\";\nimport { getItem } from \"@esri/arcgis-rest-portal\";\nimport {\n  appToOAuthAppProperties,\n  extractBaseRequestOptions\n} from \"./shared/helpers.js\";\nimport { IGetOAuthAppOptions, IOAuthApp } from \"./shared/types/oAuthType.js\";\n\n/**\n * Used to retrieve the OAuth2.0 app with given `itemId`. See the [OAuth2.0](https://developers.arcgis.com/documentation/mapping-apis-and-services/security/oauth-2.0/) for more information.\n *\n * ```js\n * import { getOAuthApp, IOAuthApp } 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 * getOAuthApp({\n *   itemId: \"xyz_itemId\",\n *   authentication: authSession\n * }).then((retrievedOAuthApp: IOAuthApp) => {\n *   // => {redirect_uris: [\"http://localhost:3000/\"], item: {tags: [\"xyz_tag1\", \"xyz_tag2\"], ...}, ...}\n * }).catch(e => {\n *   // => an exception object\n * });\n * ```\n *\n * @param requestOptions - Options for {@linkcode getOAuthApp | getOAuthApp()}, including `itemId` of which OAuth app to retrieve and an {@linkcode @esri/arcgis-rest-request!ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IOAuthApp} object representing successfully retrieved OAuth app.\n */\nexport async function getOAuthApp(\n  requestOptions: IGetOAuthAppOptions\n): Promise<IOAuthApp> {\n  const appResponse = await getRegisteredAppInfo(requestOptions);\n\n  const itemInfo = await getItem(requestOptions.itemId, {\n    ...extractBaseRequestOptions(requestOptions),\n    authentication: requestOptions.authentication\n  });\n\n  return {\n    ...appToOAuthAppProperties(appResponse),\n    item: itemInfo\n  };\n}\n"]}

package/dist/esm/shared/enum/privileges.d.ts

@@ -1,4 +1,4 @@
 /**
  * Used to describe privilege list of an app. For a comlete list of privileges, see the [list of privileges in the security and authentication guide](https://developers.arcgis.com/documentation/security-and-authentication/reference/privileges/#list-of-privileges).
  */
-export declare type Privileges = string[];
+export type Privileges = string[];

package/dist/esm/shared/getRegisteredAppInfo.d.ts

@@ -21,7 +21,7 @@ import { IGetAppInfoOptions, IApp } from "./types/appType.js";
  * });
  * ```
  *
- * @param requestOptions - Options for {@linkcode getRegisteredAppInfo | getRegisteredAppInfo()}, including an itemId of which app to retrieve and an {@linkcode ArcGISIdentityManager} authentication session.
+ * @param requestOptions - Options for {@linkcode getRegisteredAppInfo | getRegisteredAppInfo()}, including an itemId of which app to retrieve and an {@linkcode @esri/arcgis-rest-request!ArcGISIdentityManager} authentication session.
  * @returns A Promise that will resolve to an {@linkcode IApp} object representing successfully retrieved app.
  */
 export declare function getRegisteredAppInfo(requestOptions: IGetAppInfoOptions): Promise<IApp>;

package/dist/esm/shared/getRegisteredAppInfo.js

@@ -25,7 +25,7 @@ import { registeredAppResponseToApp } from "./helpers.js";
  * });
  * ```
  *
- * @param requestOptions - Options for {@linkcode getRegisteredAppInfo | getRegisteredAppInfo()}, including an itemId of which app to retrieve and an {@linkcode ArcGISIdentityManager} authentication session.
+ * @param requestOptions - Options for {@linkcode getRegisteredAppInfo | getRegisteredAppInfo()}, including an itemId of which app to retrieve and an {@linkcode @esri/arcgis-rest-request!ArcGISIdentityManager} authentication session.
  * @returns A Promise that will resolve to an {@linkcode IApp} object representing successfully retrieved app.
  */
 export async function getRegisteredAppInfo(requestOptions) {

package/dist/esm/shared/getRegisteredAppInfo.js.map

@@ -1 +1 @@
-{"version":3,"file":"getRegisteredAppInfo.js","sourceRoot":"","sources":["../../../src/shared/getRegisteredAppInfo.ts"],"names":[],"mappings":"AAAA;gBACgB;AAChB,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAOxD,OAAO,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,cAAkC;IAElC,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,cAAc,CAAC,WAAW,EAAE,CAAC;IACnE,MAAM,GAAG,GACP,YAAY,CAAC,cAAc,CAAC;QAC5B,kBAAkB,QAAQ,UAAU,cAAc,CAAC,MAAM,oBAAoB,CAAC;IAChF,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC;IAEnC,MAAM,qBAAqB,GAA2B,MAAM,OAAO,CAAC,GAAG,kCAClE,cAAc,KACjB,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,IACrB,CAAC;IAEH,OAAO,0BAA0B,CAAC,qBAAqB,CAAC,CAAC;AAC3D,CAAC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\nimport { request } from \"@esri/arcgis-rest-request\";\nimport { getPortalUrl } from \"@esri/arcgis-rest-portal\";\n\nimport {\n  IRegisteredAppResponse,\n  IGetAppInfoOptions,\n  IApp\n} from \"./types/appType.js\";\nimport { registeredAppResponseToApp } from \"./helpers.js\";\n\n/**\n * Used to retrieve registered app info. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/registered-app-info.htm) for more information.\n *\n * ```js\n * import { getRegisteredAppInfo, IApp } 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 * getRegisteredAppInfo({\n *   itemId: \"xyz_itemId\",\n *   authentication: authSession\n * }).then((registeredApp: IApp) => {\n *   // => {client_id: \"xyz_id\", client_secret: \"xyz_secret\", ...}\n * }).catch(e => {\n *   // => an exception object\n * });\n * ```\n *\n * @param requestOptions - Options for {@linkcode getRegisteredAppInfo | getRegisteredAppInfo()}, including an itemId of which app to retrieve and an {@linkcode ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IApp} object representing successfully retrieved app.\n */\nexport async function getRegisteredAppInfo(\n  requestOptions: IGetAppInfoOptions\n): Promise<IApp> {\n  const userName = await requestOptions.authentication.getUsername();\n  const url =\n    getPortalUrl(requestOptions) +\n    `/content/users/${userName}/items/${requestOptions.itemId}/registeredAppInfo`;\n  requestOptions.httpMethod = \"POST\";\n\n  const registeredAppResponse: IRegisteredAppResponse = await request(url, {\n    ...requestOptions,\n    params: { f: \"json\" }\n  });\n\n  return registeredAppResponseToApp(registeredAppResponse);\n}\n"]}
+{"version":3,"file":"getRegisteredAppInfo.js","sourceRoot":"","sources":["../../../src/shared/getRegisteredAppInfo.ts"],"names":[],"mappings":"AAAA;gBACgB;AAChB,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAOxD,OAAO,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,cAAkC;IAElC,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,cAAc,CAAC,WAAW,EAAE,CAAC;IACnE,MAAM,GAAG,GACP,YAAY,CAAC,cAAc,CAAC;QAC5B,kBAAkB,QAAQ,UAAU,cAAc,CAAC,MAAM,oBAAoB,CAAC;IAChF,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC;IAEnC,MAAM,qBAAqB,GAA2B,MAAM,OAAO,CAAC,GAAG,kCAClE,cAAc,KACjB,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,IACrB,CAAC;IAEH,OAAO,0BAA0B,CAAC,qBAAqB,CAAC,CAAC;AAC3D,CAAC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\nimport { request } from \"@esri/arcgis-rest-request\";\nimport { getPortalUrl } from \"@esri/arcgis-rest-portal\";\n\nimport {\n  IRegisteredAppResponse,\n  IGetAppInfoOptions,\n  IApp\n} from \"./types/appType.js\";\nimport { registeredAppResponseToApp } from \"./helpers.js\";\n\n/**\n * Used to retrieve registered app info. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/registered-app-info.htm) for more information.\n *\n * ```js\n * import { getRegisteredAppInfo, IApp } 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 * getRegisteredAppInfo({\n *   itemId: \"xyz_itemId\",\n *   authentication: authSession\n * }).then((registeredApp: IApp) => {\n *   // => {client_id: \"xyz_id\", client_secret: \"xyz_secret\", ...}\n * }).catch(e => {\n *   // => an exception object\n * });\n * ```\n *\n * @param requestOptions - Options for {@linkcode getRegisteredAppInfo | getRegisteredAppInfo()}, including an itemId of which app to retrieve and an {@linkcode @esri/arcgis-rest-request!ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IApp} object representing successfully retrieved app.\n */\nexport async function getRegisteredAppInfo(\n  requestOptions: IGetAppInfoOptions\n): Promise<IApp> {\n  const userName = await requestOptions.authentication.getUsername();\n  const url =\n    getPortalUrl(requestOptions) +\n    `/content/users/${userName}/items/${requestOptions.itemId}/registeredAppInfo`;\n  requestOptions.httpMethod = \"POST\";\n\n  const registeredAppResponse: IRegisteredAppResponse = await request(url, {\n    ...requestOptions,\n    params: { f: \"json\" }\n  });\n\n  return registeredAppResponseToApp(registeredAppResponse);\n}\n"]}

package/dist/esm/shared/helpers.d.ts

@@ -56,7 +56,7 @@ export declare function generateApiKeyTokens(itemId: string, slots: Array<1 | 2>
  * Convert boolean flags to an array of slots for {@linkcode generateApiKeyTokens}.
  */
 export declare function generateOptionsToSlots(generateToken1: boolean, generateToken2: boolean): Array<1 | 2>;
-declare type expirationDateParams = {
+type expirationDateParams = {
     apiToken1ExpirationDate: Date | -1;
     apiToken2ExpirationDate: Date | -1;
 } | {

package/dist/esm/shared/helpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../src/shared/helpers.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,cAA+B,EAAE,EAAE;IACjE,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QACtD,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,KAAK,CAAC;QAC3B,IAAI,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,OAAO,EAAE;YACtC,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;SACpD;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,UAAU,0BAA0B,CACxC,QAAgC;IAEhC,MAAM,WAAW,GAAG;QAClB,cAAc;QACd,iBAAiB;QACjB,WAAW;QACX,QAAQ;QACR,0BAA0B;KAC3B,CAAC;IACF,MAAM,QAAQ,GAAG,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;IAE5C,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;SACzB,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;SAC3C,MAAM,CAAC,CAAC,GAAQ,EAAE,GAAG,EAAE,EAAE;QACxB,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC1B,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,IAAI,CAAE,QAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;SAC7C;aAAM;YACL,GAAG,CAAC,GAAG,CAAC,GAAI,QAAgB,CAAC,GAAG,CAAC,CAAC;SACnC;QACD,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAE,CAAC,CAAC;AACX,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CAAC,QAAc;IAClD,OAAO,QAAQ,CAAC,aAAa,CAAC;IAC9B,OAAO,QAAQ,CAAC,aAAa,CAAC;IAC9B,OAAO,QAAQ,CAAC,OAAO,CAAC;IACxB,OAAQ,QAAgB,CAAC,wBAAwB,CAAC;IAClD,OAAO,QAAQ,CAAC,MAAM,CAAC;IAEvB,OAAO,QAAuB,CAAC;AACjC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,uBAAuB,CAAC,QAAc;IACpD,OAAO,QAAQ,CAAC,OAAO,CAAC;IACxB,OAAO,QAAQ,CAAC,aAAa,CAAC;IAC9B,OAAO,QAAQ,CAAC,UAAU,CAAC;IAC3B,OAAO,QAAQ,CAAC,MAAM,CAAC;IACvB,OAAQ,QAAgB,CAAC,wBAAwB,CAAC;IAClD,OAAO,QAAQ,CAAC,kBAAkB,CAAC;IACnC,OAAO,QAAQ,CAAC,eAAe,CAAC;IAChC,OAAO,QAAQ,CAAC,eAAe,CAAC;IAEhC,OAAO,QAAyB,CAAC;AACnC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,yBAAyB,CACvC,OAAU;IAEV,MAAM,wBAAwB,GAAmB;QAC/C,aAAa;QACb,SAAS;QACT,WAAW;QACX,YAAY;QACZ,cAAc;QACd,QAAQ;QACR,aAAa;QACb,QAAQ;QACR,kBAAkB;KACnB,CAAC;IAEF,OAAO,UAAU,CAAC,OAAO,EAAE,wBAAwB,CAAC,CAAC;AACvD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CACxB,MAAS,EACT,YAA4B;IAE5B,OAAO,YAAY,CAAC,MAAM,CACxB,CAAC,GAA6C,EAAE,GAAG,EAAE,EAAE;QACrD,IAAI,GAAG,IAAI,MAAM,EAAE;YACjB,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;SACxB;QACD,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAE,CACH,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,GAAW;IACpC,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,EAAE,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IAEtE,IAAI,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,EAAE;QAC5B,OAAO,IAAI,CAAC;KACb;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CAAC,KAAqB;IAC1D,IAAI,KAAK,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,EAAE;QAC9B,OAAO,KAAK,CAAC;KACd;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC7B,OAAO,SAAS,CAAC;KAClB;IAED,MAAM,WAAW,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IACtC,IAAI,WAAW,EAAE;QACf,OAAO,WAAW,CAAC;KACpB;AACH,CAAC;AAMD;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAClC,MAAc,EACd,KAAmB,EACnB,cAA2C;IAE3C,OAAO,OAAO,CAAC,GAAG,CAChB,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACjB,OAAO,mBAAmB,iBACxB,MAAM,EACN,MAAM,EAAE,IAAI,IACT,cAAc,EACjB,CAAC;IACL,CAAC,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE;QACnB,OAAO,SAAS;aACb,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,YAAY,CAAC;aAC1C,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;YAC5B,GAAG,CAAC,cAAc,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC;YAC/C,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAA+B,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CACpC,cAAuB,EACvB,cAAuB;IAEvB,MAAM,KAAK,GAAiB,EAAE,CAAC;IAC/B,IAAI,cAAc,EAAE;QAClB,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACf;IACD,IAAI,cAAc,EAAE;QAClB,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACf;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAeD;;;GAGG;AACH,MAAM,UAAU,yBAAyB,CACvC,cAGC,EACD,YAAsB;IAEtB,MAAM,YAAY,GAAQ,EAAE,CAAC;IAC7B,IAAI,cAAc,CAAC,uBAAuB,EAAE;QAC1C,YAAY,CAAC,uBAAuB;YAClC,cAAc,CAAC,uBAAuB,CAAC;KAC1C;IAED,IAAI,cAAc,CAAC,uBAAuB,EAAE;QAC1C,YAAY,CAAC,uBAAuB;YAClC,cAAc,CAAC,uBAAuB,CAAC;KAC1C;IAED,IAAI,YAAY,IAAI,CAAC,YAAY,CAAC,uBAAuB,EAAE;QACzD,YAAY,CAAC,uBAAuB,GAAG,CAAC,CAAC,CAAC;KAC3C;IAED,IAAI,YAAY,IAAI,CAAC,YAAY,CAAC,uBAAuB,EAAE;QACzD,YAAY,CAAC,uBAAuB,GAAG,CAAC,CAAC,CAAC;KAC3C;IACD,OAAO,YAAY,CAAC;AACtB,CAAC","sourcesContent":["import {\n  IRequestOptions,\n  IAuthenticationManager\n} from \"@esri/arcgis-rest-request\";\nimport { IRegisteredAppResponse, IApp } from \"./types/appType.js\";\nimport { IApiKeyInfo } from \"./types/apiKeyType.js\";\nimport { IOAuthAppInfo } from \"./types/oAuthType.js\";\nimport { generateApiKeyToken } from \"./generateApiKeyToken.js\";\n\n/**\n * @internal\n * Encode special params value (e.g. array type...) in advance in order to make {@linkcode encodeParam} works correctly. Usage is case by case.\n */\nexport const stringifyArrays = (requestOptions: IRequestOptions) => {\n  Object.entries(requestOptions.params).forEach((entry) => {\n    const [key, value] = entry;\n    if (value.constructor.name === \"Array\") {\n      requestOptions.params[key] = JSON.stringify(value);\n    }\n  });\n};\n\n/**\n * @internal\n * Used to convert {@linkcode IRegisteredAppResponse} to {@linkcode IApp}.\n */\nexport function registeredAppResponseToApp(\n  response: IRegisteredAppResponse\n): IApp {\n  const omittedKeys = [\n    \"apnsProdCert\",\n    \"apnsSandboxCert\",\n    \"gcmApiKey\",\n    \"isBeta\",\n    \"customAppLoginShowTriage\"\n  ];\n  const dateKeys = [\"modified\", \"registered\"];\n\n  return Object.keys(response)\n    .filter((key) => !omittedKeys.includes(key))\n    .reduce((obj: any, key) => {\n      if (dateKeys.includes(key)) {\n        obj[key] = new Date((response as any)[key]);\n      } else {\n        obj[key] = (response as any)[key];\n      }\n      return obj;\n    }, {});\n}\n\n/**\n * @internal\n * Used to convert {@linkcode IApp} to {@linkcode IApiKeyInfo} only if `appType` is \"apikey\".\n */\nexport function appToApiKeyProperties(response: IApp): IApiKeyInfo {\n  delete response.client_secret;\n  delete response.redirect_uris;\n  delete response.appType;\n  delete (response as any).customAppLoginShowTriage;\n  delete response.apiKey;\n\n  return response as IApiKeyInfo;\n}\n\n/**\n * @internal\n * Used to convert {@linkcode IApp} to {@linkcode IOAuthAppInfo}.\n */\nexport function appToOAuthAppProperties(response: IApp): IOAuthAppInfo {\n  delete response.appType;\n  delete response.httpReferrers;\n  delete response.privileges;\n  delete response.apiKey;\n  delete (response as any).customAppLoginShowTriage;\n  delete response.isPersonalAPIToken;\n  delete response.apiToken1Active;\n  delete response.apiToken2Active;\n\n  return response as IOAuthAppInfo;\n}\n\n/**\n * @internal\n * Used to extract base request options from a hybrid option and exclude `params` and `authentication`.\n */\nexport function extractBaseRequestOptions<T extends IRequestOptions>(\n  options: T\n): Partial<IRequestOptions> {\n  const requestOptionsProperties: Array<keyof T> = [\n    \"credentials\",\n    \"headers\",\n    \"hideToken\",\n    \"httpMethod\",\n    \"maxUrlLength\",\n    \"portal\",\n    \"rawResponse\",\n    \"signal\",\n    \"suppressWarnings\"\n  ];\n\n  return filterKeys(options, requestOptionsProperties);\n}\n\n/**\n * @internal\n * Used to create a new object including only specified keys from another object.\n */\nexport function filterKeys<T extends object>(\n  object: T,\n  includedKeys: Array<keyof T>\n): any {\n  return includedKeys.reduce(\n    (obj: { [key: string | number | symbol]: any }, ele) => {\n      if (ele in object) {\n        obj[ele] = object[ele];\n      }\n      return obj;\n    },\n    {}\n  );\n}\n\n/**\n * Used to determine if a generated key is in slot 1 or slot 2 key. The full API key should be passed. `undefined` will be returned if the proper slot could not be identified.\n */\nexport function slotForKey(key: string) {\n  const slot = parseInt(key.substring(key.length - 10, key.length - 9));\n\n  if (slot === 1 || slot === 2) {\n    return slot;\n  }\n\n  return undefined;\n}\n\n/**\n * @internal\n * Used to determine which slot to invalidate a key in given a number or a full or patial key.\n */\nexport function slotForInvalidationKey(param: string | 1 | 2) {\n  if (param === 1 || param === 2) {\n    return param;\n  }\n\n  if (typeof param !== \"string\") {\n    return undefined;\n  }\n\n  const fullKeySlot = slotForKey(param);\n  if (fullKeySlot) {\n    return fullKeySlot;\n  }\n}\n\ninterface IGenerateApiKeyTokenOptions extends IRequestOptions {\n  authentication: IAuthenticationManager;\n}\n\n/**\n * @internal\n * Used to generate tokens in slot 1 and/or 2 of an API key.\n */\nexport function generateApiKeyTokens(\n  itemId: string,\n  slots: Array<1 | 2>,\n  requestOptions: IGenerateApiKeyTokenOptions\n) {\n  return Promise.all(\n    slots.map((slot) => {\n      return generateApiKeyToken({\n        itemId,\n        apiKey: slot,\n        ...requestOptions\n      });\n    })\n  ).then((responses) => {\n    return responses\n      .map((responses) => responses.access_token)\n      .reduce((obj, token, index) => {\n        obj[`accessToken${slotForKey(token)}`] = token;\n        return obj;\n      }, {} as { [key: string]: string });\n  });\n}\n\n/**\n * @internal\n * Convert boolean flags to an array of slots for {@linkcode generateApiKeyTokens}.\n */\nexport function generateOptionsToSlots(\n  generateToken1: boolean,\n  generateToken2: boolean\n): Array<1 | 2> {\n  const slots: Array<1 | 2> = [];\n  if (generateToken1) {\n    slots.push(1);\n  }\n  if (generateToken2) {\n    slots.push(2);\n  }\n  return slots;\n}\n\ntype expirationDateParams =\n  | {\n      apiToken1ExpirationDate: Date | -1;\n      apiToken2ExpirationDate: Date | -1;\n    }\n  | {\n      apiToken1ExpirationDate: Date | -1;\n    }\n  | {\n      apiToken2ExpirationDate: Date | -1;\n    }\n  | {};\n\n/**\n * @internal\n * Build params for updating expiration dates\n */\nexport function buildExpirationDateParams(\n  requestOptions: {\n    apiToken1ExpirationDate?: Date;\n    apiToken2ExpirationDate?: Date;\n  },\n  fillDefaults?: boolean\n): expirationDateParams {\n  const updateparams: any = {};\n  if (requestOptions.apiToken1ExpirationDate) {\n    updateparams.apiToken1ExpirationDate =\n      requestOptions.apiToken1ExpirationDate;\n  }\n\n  if (requestOptions.apiToken2ExpirationDate) {\n    updateparams.apiToken2ExpirationDate =\n      requestOptions.apiToken2ExpirationDate;\n  }\n\n  if (fillDefaults && !updateparams.apiToken1ExpirationDate) {\n    updateparams.apiToken1ExpirationDate = -1;\n  }\n\n  if (fillDefaults && !updateparams.apiToken2ExpirationDate) {\n    updateparams.apiToken2ExpirationDate = -1;\n  }\n  return updateparams;\n}\n"]}
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../src/shared/helpers.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,cAA+B,EAAE,EAAE;IACjE,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QACtD,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,KAAK,CAAC;QAC3B,IAAI,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YACvC,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACrD,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,UAAU,0BAA0B,CACxC,QAAgC;IAEhC,MAAM,WAAW,GAAG;QAClB,cAAc;QACd,iBAAiB;QACjB,WAAW;QACX,QAAQ;QACR,0BAA0B;KAC3B,CAAC;IACF,MAAM,QAAQ,GAAG,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;IAE5C,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;SACzB,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;SAC3C,MAAM,CAAC,CAAC,GAAQ,EAAE,GAAG,EAAE,EAAE;QACxB,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC3B,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,IAAI,CAAE,QAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;QAC9C,CAAC;aAAM,CAAC;YACN,GAAG,CAAC,GAAG,CAAC,GAAI,QAAgB,CAAC,GAAG,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAE,CAAC,CAAC;AACX,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CAAC,QAAc;IAClD,OAAO,QAAQ,CAAC,aAAa,CAAC;IAC9B,OAAO,QAAQ,CAAC,aAAa,CAAC;IAC9B,OAAO,QAAQ,CAAC,OAAO,CAAC;IACxB,OAAQ,QAAgB,CAAC,wBAAwB,CAAC;IAClD,OAAO,QAAQ,CAAC,MAAM,CAAC;IAEvB,OAAO,QAAuB,CAAC;AACjC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,uBAAuB,CAAC,QAAc;IACpD,OAAO,QAAQ,CAAC,OAAO,CAAC;IACxB,OAAO,QAAQ,CAAC,aAAa,CAAC;IAC9B,OAAO,QAAQ,CAAC,UAAU,CAAC;IAC3B,OAAO,QAAQ,CAAC,MAAM,CAAC;IACvB,OAAQ,QAAgB,CAAC,wBAAwB,CAAC;IAClD,OAAO,QAAQ,CAAC,kBAAkB,CAAC;IACnC,OAAO,QAAQ,CAAC,eAAe,CAAC;IAChC,OAAO,QAAQ,CAAC,eAAe,CAAC;IAEhC,OAAO,QAAyB,CAAC;AACnC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,yBAAyB,CACvC,OAAU;IAEV,MAAM,wBAAwB,GAAmB;QAC/C,aAAa;QACb,SAAS;QACT,WAAW;QACX,YAAY;QACZ,cAAc;QACd,QAAQ;QACR,aAAa;QACb,QAAQ;QACR,kBAAkB;KACnB,CAAC;IAEF,OAAO,UAAU,CAAC,OAAO,EAAE,wBAAwB,CAAC,CAAC;AACvD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CACxB,MAAS,EACT,YAA4B;IAE5B,OAAO,YAAY,CAAC,MAAM,CACxB,CAAC,GAA6C,EAAE,GAAG,EAAE,EAAE;QACrD,IAAI,GAAG,IAAI,MAAM,EAAE,CAAC;YAClB,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAE,CACH,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,GAAW;IACpC,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,EAAE,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IAEtE,IAAI,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CAAC,KAAqB;IAC1D,IAAI,KAAK,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,WAAW,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IACtC,IAAI,WAAW,EAAE,CAAC;QAChB,OAAO,WAAW,CAAC;IACrB,CAAC;AACH,CAAC;AAMD;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAClC,MAAc,EACd,KAAmB,EACnB,cAA2C;IAE3C,OAAO,OAAO,CAAC,GAAG,CAChB,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACjB,OAAO,mBAAmB,iBACxB,MAAM,EACN,MAAM,EAAE,IAAI,IACT,cAAc,EACjB,CAAC;IACL,CAAC,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE;QACnB,OAAO,SAAS;aACb,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,YAAY,CAAC;aAC1C,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;YAC5B,GAAG,CAAC,cAAc,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC;YAC/C,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAA+B,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CACpC,cAAuB,EACvB,cAAuB;IAEvB,MAAM,KAAK,GAAiB,EAAE,CAAC;IAC/B,IAAI,cAAc,EAAE,CAAC;QACnB,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChB,CAAC;IACD,IAAI,cAAc,EAAE,CAAC;QACnB,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChB,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAeD;;;GAGG;AACH,MAAM,UAAU,yBAAyB,CACvC,cAGC,EACD,YAAsB;IAEtB,MAAM,YAAY,GAAQ,EAAE,CAAC;IAC7B,IAAI,cAAc,CAAC,uBAAuB,EAAE,CAAC;QAC3C,YAAY,CAAC,uBAAuB;YAClC,cAAc,CAAC,uBAAuB,CAAC;IAC3C,CAAC;IAED,IAAI,cAAc,CAAC,uBAAuB,EAAE,CAAC;QAC3C,YAAY,CAAC,uBAAuB;YAClC,cAAc,CAAC,uBAAuB,CAAC;IAC3C,CAAC;IAED,IAAI,YAAY,IAAI,CAAC,YAAY,CAAC,uBAAuB,EAAE,CAAC;QAC1D,YAAY,CAAC,uBAAuB,GAAG,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,YAAY,IAAI,CAAC,YAAY,CAAC,uBAAuB,EAAE,CAAC;QAC1D,YAAY,CAAC,uBAAuB,GAAG,CAAC,CAAC,CAAC;IAC5C,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC","sourcesContent":["import {\n  IRequestOptions,\n  IAuthenticationManager\n} from \"@esri/arcgis-rest-request\";\nimport { IRegisteredAppResponse, IApp } from \"./types/appType.js\";\nimport { IApiKeyInfo } from \"./types/apiKeyType.js\";\nimport { IOAuthAppInfo } from \"./types/oAuthType.js\";\nimport { generateApiKeyToken } from \"./generateApiKeyToken.js\";\n\n/**\n * @internal\n * Encode special params value (e.g. array type...) in advance in order to make {@linkcode encodeParam} works correctly. Usage is case by case.\n */\nexport const stringifyArrays = (requestOptions: IRequestOptions) => {\n  Object.entries(requestOptions.params).forEach((entry) => {\n    const [key, value] = entry;\n    if (value.constructor.name === \"Array\") {\n      requestOptions.params[key] = JSON.stringify(value);\n    }\n  });\n};\n\n/**\n * @internal\n * Used to convert {@linkcode IRegisteredAppResponse} to {@linkcode IApp}.\n */\nexport function registeredAppResponseToApp(\n  response: IRegisteredAppResponse\n): IApp {\n  const omittedKeys = [\n    \"apnsProdCert\",\n    \"apnsSandboxCert\",\n    \"gcmApiKey\",\n    \"isBeta\",\n    \"customAppLoginShowTriage\"\n  ];\n  const dateKeys = [\"modified\", \"registered\"];\n\n  return Object.keys(response)\n    .filter((key) => !omittedKeys.includes(key))\n    .reduce((obj: any, key) => {\n      if (dateKeys.includes(key)) {\n        obj[key] = new Date((response as any)[key]);\n      } else {\n        obj[key] = (response as any)[key];\n      }\n      return obj;\n    }, {});\n}\n\n/**\n * @internal\n * Used to convert {@linkcode IApp} to {@linkcode IApiKeyInfo} only if `appType` is \"apikey\".\n */\nexport function appToApiKeyProperties(response: IApp): IApiKeyInfo {\n  delete response.client_secret;\n  delete response.redirect_uris;\n  delete response.appType;\n  delete (response as any).customAppLoginShowTriage;\n  delete response.apiKey;\n\n  return response as IApiKeyInfo;\n}\n\n/**\n * @internal\n * Used to convert {@linkcode IApp} to {@linkcode IOAuthAppInfo}.\n */\nexport function appToOAuthAppProperties(response: IApp): IOAuthAppInfo {\n  delete response.appType;\n  delete response.httpReferrers;\n  delete response.privileges;\n  delete response.apiKey;\n  delete (response as any).customAppLoginShowTriage;\n  delete response.isPersonalAPIToken;\n  delete response.apiToken1Active;\n  delete response.apiToken2Active;\n\n  return response as IOAuthAppInfo;\n}\n\n/**\n * @internal\n * Used to extract base request options from a hybrid option and exclude `params` and `authentication`.\n */\nexport function extractBaseRequestOptions<T extends IRequestOptions>(\n  options: T\n): Partial<IRequestOptions> {\n  const requestOptionsProperties: Array<keyof T> = [\n    \"credentials\",\n    \"headers\",\n    \"hideToken\",\n    \"httpMethod\",\n    \"maxUrlLength\",\n    \"portal\",\n    \"rawResponse\",\n    \"signal\",\n    \"suppressWarnings\"\n  ];\n\n  return filterKeys(options, requestOptionsProperties);\n}\n\n/**\n * @internal\n * Used to create a new object including only specified keys from another object.\n */\nexport function filterKeys<T extends object>(\n  object: T,\n  includedKeys: Array<keyof T>\n): any {\n  return includedKeys.reduce(\n    (obj: { [key: string | number | symbol]: any }, ele) => {\n      if (ele in object) {\n        obj[ele] = object[ele];\n      }\n      return obj;\n    },\n    {}\n  );\n}\n\n/**\n * Used to determine if a generated key is in slot 1 or slot 2 key. The full API key should be passed. `undefined` will be returned if the proper slot could not be identified.\n */\nexport function slotForKey(key: string) {\n  const slot = parseInt(key.substring(key.length - 10, key.length - 9));\n\n  if (slot === 1 || slot === 2) {\n    return slot;\n  }\n\n  return undefined;\n}\n\n/**\n * @internal\n * Used to determine which slot to invalidate a key in given a number or a full or patial key.\n */\nexport function slotForInvalidationKey(param: string | 1 | 2) {\n  if (param === 1 || param === 2) {\n    return param;\n  }\n\n  if (typeof param !== \"string\") {\n    return undefined;\n  }\n\n  const fullKeySlot = slotForKey(param);\n  if (fullKeySlot) {\n    return fullKeySlot;\n  }\n}\n\ninterface IGenerateApiKeyTokenOptions extends IRequestOptions {\n  authentication: IAuthenticationManager;\n}\n\n/**\n * @internal\n * Used to generate tokens in slot 1 and/or 2 of an API key.\n */\nexport function generateApiKeyTokens(\n  itemId: string,\n  slots: Array<1 | 2>,\n  requestOptions: IGenerateApiKeyTokenOptions\n) {\n  return Promise.all(\n    slots.map((slot) => {\n      return generateApiKeyToken({\n        itemId,\n        apiKey: slot,\n        ...requestOptions\n      });\n    })\n  ).then((responses) => {\n    return responses\n      .map((responses) => responses.access_token)\n      .reduce((obj, token, index) => {\n        obj[`accessToken${slotForKey(token)}`] = token;\n        return obj;\n      }, {} as { [key: string]: string });\n  });\n}\n\n/**\n * @internal\n * Convert boolean flags to an array of slots for {@linkcode generateApiKeyTokens}.\n */\nexport function generateOptionsToSlots(\n  generateToken1: boolean,\n  generateToken2: boolean\n): Array<1 | 2> {\n  const slots: Array<1 | 2> = [];\n  if (generateToken1) {\n    slots.push(1);\n  }\n  if (generateToken2) {\n    slots.push(2);\n  }\n  return slots;\n}\n\ntype expirationDateParams =\n  | {\n      apiToken1ExpirationDate: Date | -1;\n      apiToken2ExpirationDate: Date | -1;\n    }\n  | {\n      apiToken1ExpirationDate: Date | -1;\n    }\n  | {\n      apiToken2ExpirationDate: Date | -1;\n    }\n  | {};\n\n/**\n * @internal\n * Build params for updating expiration dates\n */\nexport function buildExpirationDateParams(\n  requestOptions: {\n    apiToken1ExpirationDate?: Date;\n    apiToken2ExpirationDate?: Date;\n  },\n  fillDefaults?: boolean\n): expirationDateParams {\n  const updateparams: any = {};\n  if (requestOptions.apiToken1ExpirationDate) {\n    updateparams.apiToken1ExpirationDate =\n      requestOptions.apiToken1ExpirationDate;\n  }\n\n  if (requestOptions.apiToken2ExpirationDate) {\n    updateparams.apiToken2ExpirationDate =\n      requestOptions.apiToken2ExpirationDate;\n  }\n\n  if (fillDefaults && !updateparams.apiToken1ExpirationDate) {\n    updateparams.apiToken1ExpirationDate = -1;\n  }\n\n  if (fillDefaults && !updateparams.apiToken2ExpirationDate) {\n    updateparams.apiToken2ExpirationDate = -1;\n  }\n  return updateparams;\n}\n"]}

package/dist/esm/shared/registerApp.d.ts

@@ -32,7 +32,7 @@ import { IApp, IRegisterAppOptions } from "./types/appType.js";
  * });
  * ```
  *
- * @param requestOptions - Options for {@linkcode registerApp | registerApp()}, including necessary params to register an app and an {@linkcode ArcGISIdentityManager} authentication session.
+ * @param requestOptions - Options for {@linkcode registerApp | registerApp()}, including necessary params to register an app and an {@linkcode @esri/arcgis-rest-request!ArcGISIdentityManager} authentication session.
  * @returns A Promise that will resolve to an {@linkcode IApp} object representing the newly registered app.
  */
 export declare function registerApp(requestOptions: IRegisterAppOptions): Promise<IApp>;

package/dist/esm/shared/registerApp.js

@@ -36,7 +36,7 @@ import { stringifyArrays, registeredAppResponseToApp } from "./helpers.js";
  * });
  * ```
  *
- * @param requestOptions - Options for {@linkcode registerApp | registerApp()}, including necessary params to register an app and an {@linkcode ArcGISIdentityManager} authentication session.
+ * @param requestOptions - Options for {@linkcode registerApp | registerApp()}, including necessary params to register an app and an {@linkcode @esri/arcgis-rest-request!ArcGISIdentityManager} authentication session.
  * @returns A Promise that will resolve to an {@linkcode IApp} object representing the newly registered app.
  */
 export async function registerApp(requestOptions) {

package/dist/esm/shared/registerApp.js.map

@@ -1 +1 @@
-{"version":3,"file":"registerApp.js","sourceRoot":"","sources":["../../../src/shared/registerApp.ts"],"names":[],"mappings":"AAAA;gBACgB;AAEhB,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAMxD,OAAO,EAAE,eAAe,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAE3E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,cAAmC;IAEnC,eAAe;IACf,MAAM,OAAO,GAAG,kBAAkB,CAAC,cAAc,EAAE;QACjD,QAAQ;QACR,SAAS;QACT,eAAe;QACf,eAAe;QACf,YAAY;KACb,CAAC,CAAC;IACH,mHAAmH;IACnH,eAAe,CAAC,OAAO,CAAC,CAAC;IAEzB,MAAM,GAAG,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,qBAAqB,CAAC;IAC1D,OAAO,CAAC,UAAU,GAAG,MAAM,CAAC;IAC5B,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC;IAE1B,MAAM,qBAAqB,GAA2B,MAAM,OAAO,CACjE,GAAG,EACH,OAAO,CACR,CAAC;IAEF,OAAO,0BAA0B,CAAC,qBAAqB,CAAC,CAAC;AAC3D,CAAC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport { request, appendCustomParams } from \"@esri/arcgis-rest-request\";\nimport { getPortalUrl } from \"@esri/arcgis-rest-portal\";\nimport {\n  IApp,\n  IRegisterAppOptions,\n  IRegisteredAppResponse\n} from \"./types/appType.js\";\nimport { stringifyArrays, registeredAppResponseToApp } from \"./helpers.js\";\n\n/**\n * Used to register an app. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/register-app.htm) for more information.\n *\n * Accepted app types:\n * - apikey\n * - multiple\n * - browser\n * - server\n * - native\n *\n * ```js\n * import { registerApp, IApp } 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 * registerApp({\n *   itemId: \"xyz_itemId\",\n *   appType: \"multiple\",\n *   redirect_uris: [\"http://localhost:3000/\"],\n *   httpReferrers: [\"http://localhost:3000/\"],\n *   privileges: [\"premium:user:geocode:temporary\", Privileges.FeatureReport],\n *   authentication: authSession\n * }).then((registeredApp: IApp) => {\n *   // => {client_id: \"xyz_id\", client_secret: \"xyz_secret\", ...}\n * }).catch(e => {\n *   // => an exception object\n * });\n * ```\n *\n * @param requestOptions - Options for {@linkcode registerApp | registerApp()}, including necessary params to register an app and an {@linkcode ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IApp} object representing the newly registered app.\n */\nexport async function registerApp(\n  requestOptions: IRegisterAppOptions\n): Promise<IApp> {\n  // build params\n  const options = appendCustomParams(requestOptions, [\n    \"itemId\",\n    \"appType\",\n    \"redirect_uris\",\n    \"httpReferrers\",\n    \"privileges\"\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/registerApp\";\n  options.httpMethod = \"POST\";\n  options.params.f = \"json\";\n\n  const registeredAppResponse: IRegisteredAppResponse = await request(\n    url,\n    options\n  );\n\n  return registeredAppResponseToApp(registeredAppResponse);\n}\n"]}
+{"version":3,"file":"registerApp.js","sourceRoot":"","sources":["../../../src/shared/registerApp.ts"],"names":[],"mappings":"AAAA;gBACgB;AAEhB,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAMxD,OAAO,EAAE,eAAe,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAE3E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,cAAmC;IAEnC,eAAe;IACf,MAAM,OAAO,GAAG,kBAAkB,CAAC,cAAc,EAAE;QACjD,QAAQ;QACR,SAAS;QACT,eAAe;QACf,eAAe;QACf,YAAY;KACb,CAAC,CAAC;IACH,mHAAmH;IACnH,eAAe,CAAC,OAAO,CAAC,CAAC;IAEzB,MAAM,GAAG,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,qBAAqB,CAAC;IAC1D,OAAO,CAAC,UAAU,GAAG,MAAM,CAAC;IAC5B,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC;IAE1B,MAAM,qBAAqB,GAA2B,MAAM,OAAO,CACjE,GAAG,EACH,OAAO,CACR,CAAC;IAEF,OAAO,0BAA0B,CAAC,qBAAqB,CAAC,CAAC;AAC3D,CAAC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport { request, appendCustomParams } from \"@esri/arcgis-rest-request\";\nimport { getPortalUrl } from \"@esri/arcgis-rest-portal\";\nimport {\n  IApp,\n  IRegisterAppOptions,\n  IRegisteredAppResponse\n} from \"./types/appType.js\";\nimport { stringifyArrays, registeredAppResponseToApp } from \"./helpers.js\";\n\n/**\n * Used to register an app. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/register-app.htm) for more information.\n *\n * Accepted app types:\n * - apikey\n * - multiple\n * - browser\n * - server\n * - native\n *\n * ```js\n * import { registerApp, IApp } 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 * registerApp({\n *   itemId: \"xyz_itemId\",\n *   appType: \"multiple\",\n *   redirect_uris: [\"http://localhost:3000/\"],\n *   httpReferrers: [\"http://localhost:3000/\"],\n *   privileges: [\"premium:user:geocode:temporary\", Privileges.FeatureReport],\n *   authentication: authSession\n * }).then((registeredApp: IApp) => {\n *   // => {client_id: \"xyz_id\", client_secret: \"xyz_secret\", ...}\n * }).catch(e => {\n *   // => an exception object\n * });\n * ```\n *\n * @param requestOptions - Options for {@linkcode registerApp | registerApp()}, including necessary params to register an app and an {@linkcode @esri/arcgis-rest-request!ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IApp} object representing the newly registered app.\n */\nexport async function registerApp(\n  requestOptions: IRegisterAppOptions\n): Promise<IApp> {\n  // build params\n  const options = appendCustomParams(requestOptions, [\n    \"itemId\",\n    \"appType\",\n    \"redirect_uris\",\n    \"httpReferrers\",\n    \"privileges\"\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/registerApp\";\n  options.httpMethod = \"POST\";\n  options.params.f = \"json\";\n\n  const registeredAppResponse: IRegisteredAppResponse = await request(\n    url,\n    options\n  );\n\n  return registeredAppResponseToApp(registeredAppResponse);\n}\n"]}

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

@@ -41,7 +41,7 @@ export interface ICreateApiKeyOptions extends Omit<IRegisterAppOptions, "itemId"
  */
 export interface IGetApiKeyOptions extends Omit<IRequestOptions, "params"> {
     /**
-     * {@linkcode IAuthenticationManager} authentication.
+     * {@linkcode @esri/arcgis-rest-request!IAuthenticationManager} authentication.
      */
     authentication: IAuthenticationManager;
     /**
@@ -70,7 +70,7 @@ export interface IApiKeyResponse extends IApiKeyInfo {
  */
 export interface IUpdateApiKeyOptions extends Omit<IRequestOptions, "params"> {
     /**
-     * {@linkcode IAuthenticationManager} authentication.
+     * {@linkcode @esri/arcgis-rest-request!IAuthenticationManager} authentication.
      */
     authentication: IAuthenticationManager;
     /**
@@ -107,7 +107,7 @@ export interface IUpdateApiKeyOptions extends Omit<IRequestOptions, "params"> {
  */
 export interface IDeleteApiKeyOption extends Omit<IRequestOptions, "params"> {
     /**
-     * {@linkcode IAuthenticationManager} authentication.
+     * {@linkcode @esri/arcgis-rest-request!IAuthenticationManager} authentication.
      */
     authentication: IAuthenticationManager;
     /**
@@ -127,7 +127,7 @@ export interface IDeleteApiKeyResponse {
 }
 export interface IInvalidateApiKeyOptions extends Omit<IRequestOptions, "params"> {
     /**
-     * {@linkcode IAuthenticationManager} authentication.
+     * {@linkcode @esri/arcgis-rest-request!IAuthenticationManager} authentication.
      */
     authentication: IAuthenticationManager;
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"apiKeyType.js","sourceRoot":"","sources":["../../../../src/shared/types/apiKeyType.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  IAuthenticationManager,\n  IRequestOptions,\n  ISpatialReference\n} from \"@esri/arcgis-rest-request\";\nimport { IRegisterAppOptions, IApp } from \"./appType.js\";\nimport { Privileges } from \"../enum/privileges.js\";\nimport { IItem } from \"@esri/arcgis-rest-portal\";\n\n/**\n * Options to register an API Key.\n */\nexport interface ICreateApiKeyOptions\n  extends Omit<\n    IRegisterAppOptions,\n    \"itemId\" | \"redirect_uris\" | \"appType\" | \"httpReferrers\"\n  > {\n  httpReferrers?: string[];\n  title: string;\n  owner?: string;\n  typeKeywords?: string[];\n  description?: string;\n  snippet?: string;\n  documentation?: string;\n  extent?: number[][];\n  categories?: string[];\n  spatialReference?: ISpatialReference;\n  culture?: string;\n  properties?: any;\n  url?: string;\n  tags?: string[];\n  /**\n   * Expiration date of the access token in slot 1 of this API Key.\n   */\n  apiToken1ExpirationDate?: Date;\n  /**\n   * Expiration date of the access token in slot 2 of this API Key.\n   */\n  apiToken2ExpirationDate?: Date;\n  /**\n   * Generate a new access token in slot 1 of this API. Will override and invalidate any existing token.\n   */\n  generateToken1?: boolean;\n  /**\n   * Generate a new access token in slot 2 of this API. Will override and invalidate any existing token.\n   */\n  generateToken2?: boolean;\n}\n\n/**\n * Options to retrieve an API Key.\n */\nexport interface IGetApiKeyOptions extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * {@linkcode IAuthenticationManager} authentication.\n   */\n  authentication: IAuthenticationManager;\n  /**\n   * itemId of which API key to be retrieved.\n   */\n  itemId: string;\n}\n\n/**\n * Represent only the API key related properties from {@linkcode IApp}.\n */\nexport interface IApiKeyInfo\n  extends Omit<IApp, \"client_secret\" | \"redirect_uris\" | \"appType\"> {}\n\n/**\n * Return value of {@linkcode createApiKey}, {@linkcode getApiKey}, {@linkcode updateApiKey} representing an API Key entity. `accessToken1`/`accessToken2` properties are only available when `generateToken1`/`generateToken2` are `true`.\n */\nexport interface IApiKeyResponse extends IApiKeyInfo {\n  /**\n   * Represent item info attached to this API Key.\n   */\n  item: IItem;\n  accessToken1?: null | string;\n  accessToken2?: null | string;\n}\n\n/**\n * Options to update an API Key.\n */\nexport interface IUpdateApiKeyOptions extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * {@linkcode IAuthenticationManager} authentication.\n   */\n  authentication: IAuthenticationManager;\n  /**\n   * itemId of which API key will be updated.\n   */\n  itemId: string;\n  /**\n   * Override previous `httpReferrers` if this value is provided.\n   */\n  httpReferrers?: string[];\n  /**\n   * Override previous `privileges` if this value is provided.\n   */\n  privileges?: string[];\n  /**\n   * Expiration date of the access token in slot 1 of this API Key.\n   */\n  apiToken1ExpirationDate?: Date;\n  /**\n   * Expiration date of the access token in slot 2 of this API Key.\n   */\n  apiToken2ExpirationDate?: Date;\n  /**\n   * Generate a new access token in slot 1 of this API. Will override and invalidate any existing token.\n   */\n  generateToken1?: boolean;\n  /**\n   * Generate a new access token in slot 2 of this API. Will override and invalidate any existing token.\n   */\n  generateToken2?: boolean;\n}\n\n/**\n * Options to delete an API key.\n */\nexport interface IDeleteApiKeyOption extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * {@linkcode IAuthenticationManager} authentication.\n   */\n  authentication: IAuthenticationManager;\n  /**\n   * itemId of which API key to be removed.\n   */\n  itemId: string;\n}\n\n/**\n * Response of API key deletion.\n */\nexport interface IDeleteApiKeyResponse {\n  /**\n   * itemId of which API key has been removed.\n   */\n  itemId: string;\n  success: boolean;\n}\n\nexport interface IInvalidateApiKeyOptions\n  extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * {@linkcode IAuthenticationManager} authentication.\n   */\n  authentication: IAuthenticationManager;\n  /**\n   * itemId of the item of the API key to be revoked.\n   */\n  itemId: string;\n  /**\n   * The API key to be revoked. The full or partial API key or the slot number (1 or 2) can be provided.\n   */\n  apiKey?: string | 1 | 2;\n}\n\nexport interface IInvalidateApiKeyResponse {\n  success: boolean;\n}\n"]}
+{"version":3,"file":"apiKeyType.js","sourceRoot":"","sources":["../../../../src/shared/types/apiKeyType.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  IAuthenticationManager,\n  IRequestOptions,\n  ISpatialReference\n} from \"@esri/arcgis-rest-request\";\nimport { IRegisterAppOptions, IApp } from \"./appType.js\";\nimport { Privileges } from \"../enum/privileges.js\";\nimport { IItem } from \"@esri/arcgis-rest-portal\";\n\n/**\n * Options to register an API Key.\n */\nexport interface ICreateApiKeyOptions\n  extends Omit<\n    IRegisterAppOptions,\n    \"itemId\" | \"redirect_uris\" | \"appType\" | \"httpReferrers\"\n  > {\n  httpReferrers?: string[];\n  title: string;\n  owner?: string;\n  typeKeywords?: string[];\n  description?: string;\n  snippet?: string;\n  documentation?: string;\n  extent?: number[][];\n  categories?: string[];\n  spatialReference?: ISpatialReference;\n  culture?: string;\n  properties?: any;\n  url?: string;\n  tags?: string[];\n  /**\n   * Expiration date of the access token in slot 1 of this API Key.\n   */\n  apiToken1ExpirationDate?: Date;\n  /**\n   * Expiration date of the access token in slot 2 of this API Key.\n   */\n  apiToken2ExpirationDate?: Date;\n  /**\n   * Generate a new access token in slot 1 of this API. Will override and invalidate any existing token.\n   */\n  generateToken1?: boolean;\n  /**\n   * Generate a new access token in slot 2 of this API. Will override and invalidate any existing token.\n   */\n  generateToken2?: boolean;\n}\n\n/**\n * Options to retrieve an API Key.\n */\nexport interface IGetApiKeyOptions extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * {@linkcode @esri/arcgis-rest-request!IAuthenticationManager} authentication.\n   */\n  authentication: IAuthenticationManager;\n  /**\n   * itemId of which API key to be retrieved.\n   */\n  itemId: string;\n}\n\n/**\n * Represent only the API key related properties from {@linkcode IApp}.\n */\nexport interface IApiKeyInfo\n  extends Omit<IApp, \"client_secret\" | \"redirect_uris\" | \"appType\"> {}\n\n/**\n * Return value of {@linkcode createApiKey}, {@linkcode getApiKey}, {@linkcode updateApiKey} representing an API Key entity. `accessToken1`/`accessToken2` properties are only available when `generateToken1`/`generateToken2` are `true`.\n */\nexport interface IApiKeyResponse extends IApiKeyInfo {\n  /**\n   * Represent item info attached to this API Key.\n   */\n  item: IItem;\n  accessToken1?: null | string;\n  accessToken2?: null | string;\n}\n\n/**\n * Options to update an API Key.\n */\nexport interface IUpdateApiKeyOptions extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * {@linkcode @esri/arcgis-rest-request!IAuthenticationManager} authentication.\n   */\n  authentication: IAuthenticationManager;\n  /**\n   * itemId of which API key will be updated.\n   */\n  itemId: string;\n  /**\n   * Override previous `httpReferrers` if this value is provided.\n   */\n  httpReferrers?: string[];\n  /**\n   * Override previous `privileges` if this value is provided.\n   */\n  privileges?: string[];\n  /**\n   * Expiration date of the access token in slot 1 of this API Key.\n   */\n  apiToken1ExpirationDate?: Date;\n  /**\n   * Expiration date of the access token in slot 2 of this API Key.\n   */\n  apiToken2ExpirationDate?: Date;\n  /**\n   * Generate a new access token in slot 1 of this API. Will override and invalidate any existing token.\n   */\n  generateToken1?: boolean;\n  /**\n   * Generate a new access token in slot 2 of this API. Will override and invalidate any existing token.\n   */\n  generateToken2?: boolean;\n}\n\n/**\n * Options to delete an API key.\n */\nexport interface IDeleteApiKeyOption extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * {@linkcode @esri/arcgis-rest-request!IAuthenticationManager} authentication.\n   */\n  authentication: IAuthenticationManager;\n  /**\n   * itemId of which API key to be removed.\n   */\n  itemId: string;\n}\n\n/**\n * Response of API key deletion.\n */\nexport interface IDeleteApiKeyResponse {\n  /**\n   * itemId of which API key has been removed.\n   */\n  itemId: string;\n  success: boolean;\n}\n\nexport interface IInvalidateApiKeyOptions\n  extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * {@linkcode @esri/arcgis-rest-request!IAuthenticationManager} authentication.\n   */\n  authentication: IAuthenticationManager;\n  /**\n   * itemId of the item of the API key to be revoked.\n   */\n  itemId: string;\n  /**\n   * The API key to be revoked. The full or partial API key or the slot number (1 or 2) can be provided.\n   */\n  apiKey?: string | 1 | 2;\n}\n\nexport interface IInvalidateApiKeyResponse {\n  success: boolean;\n}\n"]}

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

@@ -4,7 +4,7 @@ import { Privileges } from "../enum/privileges.js";
 /**
  * Accepted app types.
  */
-export declare type AppType = "apikey" | "browser" | "native" | "server" | "multiple";
+export type AppType = "apikey" | "browser" | "native" | "server" | "multiple";
 /**
  * Options to register an app.
  */
@@ -30,7 +30,7 @@ export interface IRegisterAppOptions extends Omit<IRequestOptions, "params"> {
      */
     privileges: Privileges;
     /**
-     * {@linkcode IAuthenticationManager} authentication.
+     * {@linkcode @esri/arcgis-rest-request!IAuthenticationManager} authentication.
      */
     authentication: IAuthenticationManager;
 }
@@ -39,7 +39,7 @@ export interface IRegisterAppOptions extends Omit<IRequestOptions, "params"> {
  */
 export interface IGetAppInfoOptions extends Omit<IRequestOptions, "params"> {
     /**
-     * {@linkcode IAuthenticationManager} authentication.
+     * {@linkcode @esri/arcgis-rest-request!IAuthenticationManager} authentication.
      */
     authentication: IAuthenticationManager;
     /**
@@ -85,7 +85,7 @@ export interface IApp extends Omit<IRegisteredAppResponse, "registered" | "modif
  */
 export interface IUnregisterAppOptions extends Omit<IRequestOptions, "params"> {
     /**
-     * {@linkcode IAuthenticationManager} authentication.
+     * {@linkcode @esri/arcgis-rest-request!IAuthenticationManager} authentication.
      */
     authentication: IAuthenticationManager;
     /**