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

package/dist/cjs/createApiKey.js

@@ -6,6 +6,7 @@ exports.createApiKey = void 0;
 const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
 const registerApp_js_1 = require("./shared/registerApp.js");
 const helpers_js_1 = require("./shared/helpers.js");
+const getRegisteredAppInfo_js_1 = require("./shared/getRegisteredAppInfo.js");
 /**
  * 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.
  *
@@ -22,7 +23,7 @@ const helpers_js_1 = require("./shared/helpers.js");
  *   title: "xyz_title",
  *   description: "xyz_desc",
  *   tags: ["xyz_tag1", "xyz_tag2"],
- *   privileges: [Privileges.Geocode, Privileges.FeatureReport],
+ *   privileges: ["premium:user:networkanalysis:routing"],
  *   authentication: authSession
  * }).then((registeredAPIKey: IApiKeyResponse) => {
  *   // => {apiKey: "xyz_key", item: {tags: ["xyz_tag1", "xyz_tag2"], ...}, ...}
@@ -35,9 +36,6 @@ const helpers_js_1 = require("./shared/helpers.js");
  * @returns A Promise that will resolve to an {@linkcode IApiKeyResponse} object representing the newly registered API key.
  */
 async function createApiKey(requestOptions) {
-    if (!(0, helpers_js_1.arePrivilegesValid)(requestOptions.privileges)) {
-        throw new Error("The `privileges` option contains invalid privileges.");
-    }
     requestOptions.httpMethod = "POST";
     // filter param buckets:
     const baseRequestOptions = (0, helpers_js_1.extractBaseRequestOptions)(requestOptions); // snapshot of basic IRequestOptions before customized params being built into it
@@ -57,16 +55,37 @@ async function createApiKey(requestOptions) {
         "typeKeywords",
         "url"
     ];
-    // step 1: add item
-    const createItemOption = Object.assign(Object.assign({ item: Object.assign(Object.assign({}, (0, helpers_js_1.filterKeys)(requestOptions, itemAddProperties)), { type: "API Key" }) }, baseRequestOptions), { authentication: requestOptions.authentication, params: {
+    /**
+     * step 1: create item
+     */
+    const createItemOption = Object.assign(Object.assign({ item: Object.assign(Object.assign({}, (0, helpers_js_1.filterKeys)(requestOptions, itemAddProperties)), { type: "Application" }) }, baseRequestOptions), { authentication: requestOptions.authentication, params: {
             f: "json"
         } });
     const createItemResponse = await (0, arcgis_rest_portal_1.createItem)(createItemOption);
-    // step 2: register app
-    const registerAppOption = Object.assign(Object.assign({ itemId: createItemResponse.id, appType: "apikey", redirect_uris: [], httpReferrers: requestOptions.httpReferrers || [], privileges: requestOptions.privileges }, baseRequestOptions), { authentication: requestOptions.authentication });
-    const registeredAppResponse = await (0, registerApp_js_1.registerApp)(registerAppOption);
+    /**
+     * getRegisteredAppInfoRoute
+     */
+    const registerAppOptions = Object.assign(Object.assign({ itemId: createItemResponse.id, appType: "multiple", redirect_uris: ["urn:ietf:wg:oauth:2.0:oob"], httpReferrers: requestOptions.httpReferrers || [], privileges: requestOptions.privileges }, baseRequestOptions), { authentication: requestOptions.authentication });
+    const registeredAppResponse = await (0, registerApp_js_1.registerApp)(registerAppOptions);
+    /**
+     * step 3: update item with desired expiration dates
+     * you cannot set the expiration date propierties until you
+     * regiester the app so this has to be a seperate step
+     */
+    await (0, arcgis_rest_portal_1.updateItem)(Object.assign(Object.assign({}, baseRequestOptions), { item: Object.assign({ id: createItemResponse.id }, (0, helpers_js_1.buildExpirationDateParams)(requestOptions, true)), authentication: requestOptions.authentication }));
+    /*
+     * step 4: get item info
+     */
     const itemInfo = await (0, arcgis_rest_portal_1.getItem)(registeredAppResponse.itemId, Object.assign(Object.assign({}, baseRequestOptions), { authentication: requestOptions.authentication, params: { f: "json" } }));
-    return Object.assign(Object.assign({}, (0, helpers_js_1.appToApiKeyProperties)(registeredAppResponse)), { item: itemInfo });
+    /**
+     * step 5: generate tokens if requested
+     */
+    const generatedTokens = await (0, helpers_js_1.generateApiKeyTokens)(itemInfo.id, (0, helpers_js_1.generateOptionsToSlots)(requestOptions.generateToken1, requestOptions.generateToken2), Object.assign(Object.assign({}, baseRequestOptions), { authentication: requestOptions.authentication }));
+    /**
+     * step 6: get registered app info to get updated active key status
+     */
+    const updatedRegisteredAppResponse = await (0, getRegisteredAppInfo_js_1.getRegisteredAppInfo)(Object.assign(Object.assign({}, baseRequestOptions), { itemId: itemInfo.id, authentication: requestOptions.authentication }));
+    return Object.assign(Object.assign(Object.assign({}, generatedTokens), (0, helpers_js_1.appToApiKeyProperties)(updatedRegisteredAppResponse)), { item: itemInfo });
 }
 exports.createApiKey = createApiKey;
 //# sourceMappingURL=createApiKey.js.map

package/dist/cjs/createApiKey.js.map

@@ -1 +1 @@
-{"version":3,"file":"createApiKey.js","sourceRoot":"","sources":["../../src/createApiKey.ts"],"names":[],"mappings":";AAAA;gBACgB;;;AAEhB,iEAKkC;AAMlC,4DAAsD;AAEtD,oDAK6B;AAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACI,KAAK,UAAU,YAAY,CAChC,cAAoC;IAEpC,IAAI,CAAC,IAAA,+BAAkB,EAAC,cAAc,CAAC,UAAU,CAAC,EAAE;QAClD,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;KACzE;IAED,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC;IAEnC,wBAAwB;IAExB,MAAM,kBAAkB,GAAG,IAAA,sCAAyB,EAAC,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,mBAAmB;IACnB,MAAM,gBAAgB,iCACpB,IAAI,kCACC,IAAA,uBAAU,EAAC,cAAqB,EAAE,iBAAiB,CAAC,KACvD,IAAI,EAAE,SAAS,OAEd,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE;YACN,CAAC,EAAE,MAAM;SACV,GACF,CAAC;IAEF,MAAM,kBAAkB,GAAG,MAAM,IAAA,+BAAU,EAAC,gBAAgB,CAAC,CAAC;IAE9D,uBAAuB;IACvB,MAAM,iBAAiB,iCACrB,MAAM,EAAE,kBAAkB,CAAC,EAAE,EAC7B,OAAO,EAAE,QAAQ,EACjB,aAAa,EAAE,EAAE,EACjB,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,IAAA,4BAAW,EAAC,iBAAiB,CAAC,CAAC;IACnE,MAAM,QAAQ,GAAG,MAAM,IAAA,4BAAO,EAAC,qBAAqB,CAAC,MAAM,kCACtD,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,IACrB,CAAC;IAEH,uCACK,IAAA,kCAAqB,EAAC,qBAAqB,CAAC,KAC/C,IAAI,EAAE,QAAQ,IACd;AACJ,CAAC;AAnED,oCAmEC","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\";\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  arePrivilegesValid\n} from \"./shared/helpers.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 * createApiKey({\n *   title: \"xyz_title\",\n *   description: \"xyz_desc\",\n *   tags: [\"xyz_tag1\", \"xyz_tag2\"],\n *   privileges: [Privileges.Geocode, Privileges.FeatureReport],\n *   authentication: authSession\n * }).then((registeredAPIKey: 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 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  if (!arePrivilegesValid(requestOptions.privileges)) {\n    throw new Error(\"The `privileges` option contains invalid privileges.\");\n  }\n\n  requestOptions.httpMethod = \"POST\";\n\n  // filter param buckets:\n\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  // step 1: add item\n  const createItemOption: ICreateItemOptions = {\n    item: {\n      ...filterKeys(requestOptions as any, itemAddProperties),\n      type: \"API Key\"\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: \"apikey\",\n    redirect_uris: [],\n    httpReferrers: requestOptions.httpReferrers || [],\n    privileges: requestOptions.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    ...appToApiKeyProperties(registeredAppResponse),\n    item: itemInfo\n  };\n}\n"]}
+{"version":3,"file":"createApiKey.js","sourceRoot":"","sources":["../../src/createApiKey.ts"],"names":[],"mappings":";AAAA;gBACgB;;;AAEhB,iEAMkC;AAMlC,4DAAsD;AAEtD,oDAO6B;AAC7B,8EAAwE;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACI,KAAK,UAAU,YAAY,CAChC,cAAoC;IAEpC,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC;IAEnC,wBAAwB;IACxB,MAAM,kBAAkB,GAAG,IAAA,sCAAyB,EAAC,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,IAAA,uBAAU,EAAC,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,IAAA,+BAAU,EAAC,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,IAAA,4BAAW,EAAC,kBAAkB,CAAC,CAAC;IAEpE;;;;OAIG;IACH,MAAM,IAAA,+BAAU,kCACX,kBAAkB,KACrB,IAAI,kBACF,EAAE,EAAE,kBAAkB,CAAC,EAAE,IACtB,IAAA,sCAAyB,EAAC,cAAc,EAAE,IAAI,CAAC,GAEpD,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH;;OAEG;IACH,MAAM,QAAQ,GAAG,MAAM,IAAA,4BAAO,EAAC,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,IAAA,iCAAoB,EAChD,QAAQ,CAAC,EAAE,EACX,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,QAAQ,CAAC,EAAE,EACnB,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH,qDACK,eAAe,GACf,IAAA,kCAAqB,EAAC,4BAA4B,CAAC,KACtD,IAAI,EAAE,QAAQ,IACd;AACJ,CAAC;AA7GD,oCA6GC","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 * 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 * }).then((registeredAPIKey: 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 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"]}

package/dist/cjs/index.js

@@ -6,8 +6,6 @@ const tslib_1 = require("tslib");
 (0, tslib_1.__exportStar)(require("./createApiKey.js"), exports);
 (0, tslib_1.__exportStar)(require("./updateApiKey.js"), exports);
 (0, tslib_1.__exportStar)(require("./getApiKey.js"), exports);
-(0, tslib_1.__exportStar)(require("./deleteApiKey.js"), exports);
-(0, tslib_1.__exportStar)(require("./deleteOAuthApp.js"), exports);
 (0, tslib_1.__exportStar)(require("./getOAuthApp.js"), exports);
 (0, tslib_1.__exportStar)(require("./updateOAuthApp.js"), exports);
 (0, tslib_1.__exportStar)(require("./createOAuthApp.js"), exports);

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;gBACgB;;;AAEhB,iEAAkC;AAClC,iEAAkC;AAClC,8DAA+B;AAC/B,iEAAkC;AAClC,mEAAoC;AACpC,gEAAiC;AACjC,mEAAoC;AACpC,mEAAoC;AACpC,2EAA4C;AAC5C,yEAA0C;AAC1C,4EAA6C;AAC7C,2EAA4C;AAC5C,gFAAiD;AACjD,uEAAwC;AACxC,yEAA0C;AAC1C,mEAAoC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nexport * from \"./createApiKey.js\";\nexport * from \"./updateApiKey.js\";\nexport * from \"./getApiKey.js\";\nexport * from \"./deleteApiKey.js\";\nexport * from \"./deleteOAuthApp.js\";\nexport * from \"./getOAuthApp.js\";\nexport * from \"./updateOAuthApp.js\";\nexport * from \"./createOAuthApp.js\";\nexport * from \"./shared/enum/privileges.js\";\nexport * from \"./shared/types/appType.js\";\nexport * from \"./shared/types/apiKeyType.js\";\nexport * from \"./shared/types/oAuthType.js\";\nexport * from \"./shared/getRegisteredAppInfo.js\";\nexport * from \"./shared/registerApp.js\";\nexport * from \"./shared/unregisterApp.js\";\nexport * from \"./shared/helpers.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;gBACgB;;;AAEhB,iEAAkC;AAClC,iEAAkC;AAClC,8DAA+B;AAC/B,gEAAiC;AACjC,mEAAoC;AACpC,mEAAoC;AACpC,2EAA4C;AAC5C,yEAA0C;AAC1C,4EAA6C;AAC7C,2EAA4C;AAC5C,gFAAiD;AACjD,uEAAwC;AACxC,yEAA0C;AAC1C,mEAAoC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nexport * from \"./createApiKey.js\";\nexport * from \"./updateApiKey.js\";\nexport * from \"./getApiKey.js\";\nexport * from \"./getOAuthApp.js\";\nexport * from \"./updateOAuthApp.js\";\nexport * from \"./createOAuthApp.js\";\nexport * from \"./shared/enum/privileges.js\";\nexport * from \"./shared/types/appType.js\";\nexport * from \"./shared/types/apiKeyType.js\";\nexport * from \"./shared/types/oAuthType.js\";\nexport * from \"./shared/getRegisteredAppInfo.js\";\nexport * from \"./shared/registerApp.js\";\nexport * from \"./shared/unregisterApp.js\";\nexport * from \"./shared/helpers.js\";\n"]}

package/dist/cjs/shared/enum/privileges.js

@@ -1,30 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Privileges = void 0;
-/**
- * Used to describe privilege list of an app.
- */
-var Privileges;
-(function (Privileges) {
-    Privileges["Basemaps"] = "portal:apikey:basemaps";
-    Privileges["Demographics"] = "premium:user:demographics";
-    Privileges["Elevation"] = "premium:user:elevation";
-    Privileges["FeatureReport"] = "premium:user:featurereport";
-    Privileges["Geocode"] = "premium:user:geocode";
-    Privileges["GeocodeStored"] = "premium:user:geocode:stored";
-    Privileges["GeocodeTemporary"] = "premium:user:geocode:temporary";
-    Privileges["GeoEnrichment"] = "premium:user:geoenrichment";
-    Privileges["NetworkAnalysis"] = "premium:user:networkanalysis";
-    Privileges["NetworkAnalysisRouting"] = "premium:user:networkanalysis:routing";
-    Privileges["NetworkAnalysisOptimizedRouting"] = "premium:user:networkanalysis:optimizedrouting";
-    Privileges["NetworkAnalysisClosestFacility"] = "premium:user:networkanalysis:closestfacility";
-    Privileges["NetworkAnalysisServiceArea"] = "premium:user:networkanalysis:servicearea";
-    Privileges["NetworkAnalysisLocationalLocation"] = "premium:user:networkanalysis:locationallocation";
-    Privileges["NetworkAnalysisVehicleRouting"] = "premium:user:networkanalysis:vehiclerouting";
-    Privileges["NetworkAnalysisOriginDestinationCostMatrix"] = "premium:user:networkanalysis:origindestinationcostmatrix";
-    Privileges["Places"] = "premium:user:places";
-    Privileges["SpatialAnalysis"] = "premium:user:spatialanalysis";
-    Privileges["GeoAnalytics"] = "premium:publisher:geoanalytics";
-    Privileges["RasterAnalysis"] = "premium:publisher:rasteranalysis";
-})(Privileges = exports.Privileges || (exports.Privileges = {}));
 //# sourceMappingURL=privileges.js.map

package/dist/cjs/shared/enum/privileges.js.map

@@ -1 +1 @@
-{"version":3,"file":"privileges.js","sourceRoot":"","sources":["../../../../src/shared/enum/privileges.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,UAqBX;AArBD,WAAY,UAAU;IACpB,iDAAmC,CAAA;IACnC,wDAA0C,CAAA;IAC1C,kDAAoC,CAAA;IACpC,0DAA4C,CAAA;IAC5C,8CAAgC,CAAA;IAChC,2DAA6C,CAAA;IAC7C,iEAAmD,CAAA;IACnD,0DAA4C,CAAA;IAC5C,8DAAgD,CAAA;IAChD,6EAA+D,CAAA;IAC/D,+FAAiF,CAAA;IACjF,6FAA+E,CAAA;IAC/E,qFAAuE,CAAA;IACvE,mGAAqF,CAAA;IACrF,2FAA6E,CAAA;IAC7E,qHAAuG,CAAA;IACvG,4CAA8B,CAAA;IAC9B,8DAAgD,CAAA;IAChD,6DAA+C,CAAA;IAC/C,iEAAmD,CAAA;AACrD,CAAC,EArBW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAqBrB","sourcesContent":["/**\n * Used to describe privilege list of an app.\n */\nexport enum Privileges {\n  Basemaps = \"portal:apikey:basemaps\",\n  Demographics = \"premium:user:demographics\",\n  Elevation = \"premium:user:elevation\",\n  FeatureReport = \"premium:user:featurereport\",\n  Geocode = \"premium:user:geocode\",\n  GeocodeStored = \"premium:user:geocode:stored\",\n  GeocodeTemporary = \"premium:user:geocode:temporary\",\n  GeoEnrichment = \"premium:user:geoenrichment\",\n  NetworkAnalysis = \"premium:user:networkanalysis\",\n  NetworkAnalysisRouting = \"premium:user:networkanalysis:routing\",\n  NetworkAnalysisOptimizedRouting = \"premium:user:networkanalysis:optimizedrouting\",\n  NetworkAnalysisClosestFacility = \"premium:user:networkanalysis:closestfacility\",\n  NetworkAnalysisServiceArea = \"premium:user:networkanalysis:servicearea\",\n  NetworkAnalysisLocationalLocation = \"premium:user:networkanalysis:locationallocation\",\n  NetworkAnalysisVehicleRouting = \"premium:user:networkanalysis:vehiclerouting\",\n  NetworkAnalysisOriginDestinationCostMatrix = \"premium:user:networkanalysis:origindestinationcostmatrix\",\n  Places = \"premium:user:places\",\n  SpatialAnalysis = \"premium:user:spatialanalysis\",\n  GeoAnalytics = \"premium:publisher:geoanalytics\",\n  RasterAnalysis = \"premium:publisher:rasteranalysis\"\n}\n"]}
+{"version":3,"file":"privileges.js","sourceRoot":"","sources":["../../../../src/shared/enum/privileges.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * 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).\n */\nexport type Privileges = string[];\n"]}

package/dist/cjs/shared/generateApiKeyToken.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateApiKeyToken = void 0;
+const arcgis_rest_request_1 = require("@esri/arcgis-rest-request");
+const getRegisteredAppInfo_js_1 = require("./getRegisteredAppInfo.js");
+const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
+async function generateApiKeyToken(options) {
+    const portal = (0, arcgis_rest_portal_1.getPortalUrl)(options);
+    const url = `${portal}/oauth2/token`;
+    const appInfo = await (0, getRegisteredAppInfo_js_1.getRegisteredAppInfo)({
+        itemId: options.itemId,
+        authentication: options.authentication
+    });
+    const params = {
+        client_id: appInfo.client_id,
+        client_secret: appInfo.client_secret,
+        apiToken: options.apiKey,
+        regenerateApiToken: true,
+        grant_type: "client_credentials"
+    };
+    return (0, arcgis_rest_request_1.request)(url, {
+        authentication: options.authentication,
+        params
+    });
+}
+exports.generateApiKeyToken = generateApiKeyToken;
+//# sourceMappingURL=generateApiKeyToken.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"generateApiKeyToken.js","sourceRoot":"","sources":["../../../src/shared/generateApiKeyToken.ts"],"names":[],"mappings":";;;AAAA,mEAImC;AACnC,uEAAiE;AACjE,iEAAwD;AASjD,KAAK,UAAU,mBAAmB,CACvC,OAAoC;IAEpC,MAAM,MAAM,GAAG,IAAA,iCAAY,EAAC,OAAO,CAAC,CAAC;IACrC,MAAM,GAAG,GAAG,GAAG,MAAM,eAAe,CAAC;IAErC,MAAM,OAAO,GAAG,MAAM,IAAA,8CAAoB,EAAC;QACzC,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,cAAc,EAAE,OAAO,CAAC,cAAc;KACvC,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG;QACb,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,aAAa,EAAE,OAAO,CAAC,aAAa;QACpC,QAAQ,EAAE,OAAO,CAAC,MAAM;QACxB,kBAAkB,EAAE,IAAI;QACxB,UAAU,EAAE,oBAAoB;KACjC,CAAC;IAEF,OAAO,IAAA,6BAAO,EAAC,GAAG,EAAE;QAClB,cAAc,EAAE,OAAO,CAAC,cAAc;QACtC,MAAM;KACP,CAAC,CAAC;AACL,CAAC;AAvBD,kDAuBC","sourcesContent":["import {\n  request,\n  IRequestOptions,\n  IAuthenticationManager\n} from \"@esri/arcgis-rest-request\";\nimport { getRegisteredAppInfo } from \"./getRegisteredAppInfo.js\";\nimport { getPortalUrl } from \"@esri/arcgis-rest-portal\";\n\nexport interface IGenerateApiKeyTokenOptions extends IRequestOptions {\n  itemId: string;\n  apiKey: 1 | 2;\n  portal?: string;\n  authentication: IAuthenticationManager;\n}\n\nexport async function generateApiKeyToken(\n  options: IGenerateApiKeyTokenOptions\n): Promise<{ access_token: string; expires_in: number }> {\n  const portal = getPortalUrl(options);\n  const url = `${portal}/oauth2/token`;\n\n  const appInfo = await getRegisteredAppInfo({\n    itemId: options.itemId,\n    authentication: options.authentication\n  });\n\n  const params = {\n    client_id: appInfo.client_id,\n    client_secret: appInfo.client_secret,\n    apiToken: options.apiKey,\n    regenerateApiToken: true,\n    grant_type: \"client_credentials\"\n  };\n\n  return request(url, {\n    authentication: options.authentication,\n    params\n  });\n}\n"]}

package/dist/cjs/shared/helpers.js

@@ -1,13 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.filterKeys = exports.extractBaseRequestOptions = exports.appToOAuthAppProperties = exports.appToApiKeyProperties = exports.registeredAppResponseToApp = exports.stringifyArrays = exports.arePrivilegesValid = void 0;
-const privileges_js_1 = require("./enum/privileges.js");
-/**
- * @internal
- * Used to check privileges validity.
- */
-const arePrivilegesValid = (privileges) => privileges.every((element) => Object.values(privileges_js_1.Privileges).includes(element));
-exports.arePrivilegesValid = arePrivilegesValid;
+exports.buildExpirationDateParams = exports.generateOptionsToSlots = exports.generateApiKeyTokens = exports.slotForKey = exports.filterKeys = exports.extractBaseRequestOptions = exports.appToOAuthAppProperties = exports.appToApiKeyProperties = exports.registeredAppResponseToApp = exports.stringifyArrays = void 0;
+const generateApiKeyToken_js_1 = require("./generateApiKeyToken.js");
 /**
  * @internal
  * Encode special params value (e.g. array type...) in advance in order to make {@linkcode encodeParam} works correctly. Usage is case by case.
@@ -30,7 +24,8 @@ function registeredAppResponseToApp(response) {
         "apnsProdCert",
         "apnsSandboxCert",
         "gcmApiKey",
-        "isBeta"
+        "isBeta",
+        "customAppLoginShowTriage"
     ];
     const dateKeys = ["modified", "registered"];
     return Object.keys(response)
@@ -51,13 +46,11 @@ exports.registeredAppResponseToApp = registeredAppResponseToApp;
  * Used to convert {@linkcode IApp} to {@linkcode IApiKeyInfo} only if `appType` is "apikey".
  */
 function appToApiKeyProperties(response) {
-    if (response.appType !== "apikey" || !("apiKey" in response)) {
-        throw new Error("Item is not an API key.");
-    }
-    delete response.client_id;
     delete response.client_secret;
     delete response.redirect_uris;
     delete response.appType;
+    delete response.customAppLoginShowTriage;
+    delete response.apiKey;
     return response;
 }
 exports.appToApiKeyProperties = appToApiKeyProperties;
@@ -66,12 +59,14 @@ exports.appToApiKeyProperties = appToApiKeyProperties;
  * Used to convert {@linkcode IApp} to {@linkcode IOAuthAppInfo}.
  */
 function appToOAuthAppProperties(response) {
-    if (response.appType === "apikey") {
-        throw new Error("Item is not an OAuth 2.0 app.");
-    }
     delete response.appType;
     delete response.httpReferrers;
     delete response.privileges;
+    delete response.apiKey;
+    delete response.customAppLoginShowTriage;
+    delete response.isPersonalAPIToken;
+    delete response.apiToken1Active;
+    delete response.apiToken2Active;
     return response;
 }
 exports.appToOAuthAppProperties = appToOAuthAppProperties;
@@ -107,4 +102,66 @@ function filterKeys(object, includedKeys) {
     }, {});
 }
 exports.filterKeys = filterKeys;
+/**
+ * Used to determine if a generated key is in slot 1 or slot 2 key.
+ */
+function slotForKey(key) {
+    return parseInt(key.substring(key.length - 10, key.length - 9));
+}
+exports.slotForKey = slotForKey;
+/**
+ * @internal
+ * Used to generate tokens in slot 1 and/or 2 of an API key.
+ */
+function generateApiKeyTokens(itemId, slots, requestOptions) {
+    return Promise.all(slots.map((slot) => {
+        return (0, generateApiKeyToken_js_1.generateApiKeyToken)(Object.assign({ itemId, apiKey: slot }, requestOptions));
+    })).then((responses) => {
+        return responses
+            .map((responses) => responses.access_token)
+            .reduce((obj, token, index) => {
+            obj[`accessToken${slotForKey(token)}`] = token;
+            return obj;
+        }, {});
+    });
+}
+exports.generateApiKeyTokens = generateApiKeyTokens;
+/**
+ * @internal
+ * Convert boolean flags to an array of slots for {@linkcode generateApiKeyTokens}.
+ */
+function generateOptionsToSlots(generateToken1, generateToken2) {
+    const slots = [];
+    if (generateToken1) {
+        slots.push(1);
+    }
+    if (generateToken2) {
+        slots.push(2);
+    }
+    return slots;
+}
+exports.generateOptionsToSlots = generateOptionsToSlots;
+/**
+ * @internal
+ * Build params for updating expiration dates
+ */
+function buildExpirationDateParams(requestOptions, fillDefaults) {
+    const updateparams = {};
+    if (requestOptions.apiToken1ExpirationDate) {
+        updateparams.apiToken1ExpirationDate =
+            requestOptions.apiToken1ExpirationDate;
+    }
+    if (requestOptions.apiToken2ExpirationDate) {
+        updateparams.apiToken2ExpirationDate =
+            requestOptions.apiToken2ExpirationDate;
+    }
+    if (fillDefaults && !updateparams.apiToken1ExpirationDate) {
+        updateparams.apiToken1ExpirationDate = -1;
+    }
+    if (fillDefaults && !updateparams.apiToken2ExpirationDate) {
+        updateparams.apiToken2ExpirationDate = -1;
+    }
+    return updateparams;
+}
+exports.buildExpirationDateParams = buildExpirationDateParams;
 //# sourceMappingURL=helpers.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../src/shared/helpers.ts"],"names":[],"mappings":";;;AACA,wDAAkD;AAKlD;;;GAGG;AACI,MAAM,kBAAkB,GAAG,CAChC,UAA+C,EACtC,EAAE,CACX,UAAU,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE,CAC3B,MAAM,CAAC,MAAM,CAAC,0BAAU,CAAC,CAAC,QAAQ,CAAC,OAAc,CAAC,CACnD,CAAC;AALS,QAAA,kBAAkB,sBAK3B;AAEJ;;;GAGG;AACI,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;AAPW,QAAA,eAAe,mBAO1B;AAEF;;;GAGG;AACH,SAAgB,0BAA0B,CACxC,QAAgC;IAEhC,MAAM,WAAW,GAAG;QAClB,cAAc;QACd,iBAAiB;QACjB,WAAW;QACX,QAAQ;KACT,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;AArBD,gEAqBC;AAED;;;GAGG;AACH,SAAgB,qBAAqB,CAAC,QAAc;IAClD,IAAI,QAAQ,CAAC,OAAO,KAAK,QAAQ,IAAI,CAAC,CAAC,QAAQ,IAAI,QAAQ,CAAC,EAAE;QAC5D,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;KAC5C;IAED,OAAO,QAAQ,CAAC,SAAS,CAAC;IAC1B,OAAO,QAAQ,CAAC,aAAa,CAAC;IAC9B,OAAO,QAAQ,CAAC,aAAa,CAAC;IAC9B,OAAO,QAAQ,CAAC,OAAO,CAAC;IAExB,OAAO,QAAuB,CAAC;AACjC,CAAC;AAXD,sDAWC;AAED;;;GAGG;AACH,SAAgB,uBAAuB,CAAC,QAAc;IACpD,IAAI,QAAQ,CAAC,OAAO,KAAK,QAAQ,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;KAClD;IAED,OAAO,QAAQ,CAAC,OAAO,CAAC;IACxB,OAAO,QAAQ,CAAC,aAAa,CAAC;IAC9B,OAAO,QAAQ,CAAC,UAAU,CAAC;IAE3B,OAAO,QAAyB,CAAC;AACnC,CAAC;AAVD,0DAUC;AAED;;;GAGG;AACH,SAAgB,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;AAhBD,8DAgBC;AAED;;;GAGG;AACH,SAAgB,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;AAbD,gCAaC","sourcesContent":["import { IRequestOptions } from \"@esri/arcgis-rest-request\";\nimport { Privileges } from \"./enum/privileges.js\";\nimport { IRegisteredAppResponse, IApp } from \"./types/appType.js\";\nimport { IApiKeyInfo } from \"./types/apiKeyType.js\";\nimport { IOAuthAppInfo } from \"./types/oAuthType.js\";\n\n/**\n * @internal\n * Used to check privileges validity.\n */\nexport const arePrivilegesValid = (\n  privileges: Array<Privileges | `${Privileges}`>\n): boolean =>\n  privileges.every((element) =>\n    Object.values(Privileges).includes(element as any)\n  );\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  ];\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  if (response.appType !== \"apikey\" || !(\"apiKey\" in response)) {\n    throw new Error(\"Item is not an API key.\");\n  }\n\n  delete response.client_id;\n  delete response.client_secret;\n  delete response.redirect_uris;\n  delete response.appType;\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  if (response.appType === \"apikey\") {\n    throw new Error(\"Item is not an OAuth 2.0 app.\");\n  }\n\n  delete response.appType;\n  delete response.httpReferrers;\n  delete response.privileges;\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"]}
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../src/shared/helpers.ts"],"names":[],"mappings":";;;AAOA,qEAA+D;AAE/D;;;GAGG;AACI,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;AAPW,QAAA,eAAe,mBAO1B;AAEF;;;GAGG;AACH,SAAgB,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;AAtBD,gEAsBC;AAED;;;GAGG;AACH,SAAgB,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;AARD,sDAQC;AAED;;;GAGG;AACH,SAAgB,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;AAXD,0DAWC;AAED;;;GAGG;AACH,SAAgB,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;AAhBD,8DAgBC;AAED;;;GAGG;AACH,SAAgB,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;AAbD,gCAaC;AAED;;GAEG;AACH,SAAgB,UAAU,CAAC,GAAW;IACpC,OAAO,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,EAAE,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;AAClE,CAAC;AAFD,gCAEC;AAMD;;;GAGG;AACH,SAAgB,oBAAoB,CAClC,MAAc,EACd,KAAmB,EACnB,cAA2C;IAE3C,OAAO,OAAO,CAAC,GAAG,CAChB,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACjB,OAAO,IAAA,4CAAmB,kBACxB,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;AArBD,oDAqBC;AAED;;;GAGG;AACH,SAAgB,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;AAZD,wDAYC;AAeD;;;GAGG;AACH,SAAgB,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;AA1BD,8DA0BC","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.\n */\nexport function slotForKey(key: string) {\n  return parseInt(key.substring(key.length - 10, key.length - 9));\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/cjs/shared/registerApp.js

@@ -43,10 +43,6 @@ const helpers_js_1 = require("./helpers.js");
  * @returns A Promise that will resolve to an {@linkcode IApp} object representing the newly registered app.
  */
 async function registerApp(requestOptions) {
-    // privileges validation
-    if (!(0, helpers_js_1.arePrivilegesValid)(requestOptions.privileges)) {
-        throw new Error("The `privileges` option contains invalid privileges.");
-    }
     // build params
     const options = (0, arcgis_rest_request_1.appendCustomParams)(requestOptions, [
         "itemId",

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

@@ -1 +1 @@
-{"version":3,"file":"registerApp.js","sourceRoot":"","sources":["../../../src/shared/registerApp.ts"],"names":[],"mappings":";AAAA;gBACgB;;;AAEhB,mEAAwE;AACxE,iEAAwD;AAMxD,6CAIsB;AAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACI,KAAK,UAAU,WAAW,CAC/B,cAAmC;IAEnC,wBAAwB;IACxB,IAAI,CAAC,IAAA,+BAAkB,EAAC,cAAc,CAAC,UAAU,CAAC,EAAE;QAClD,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;KACzE;IAED,eAAe;IACf,MAAM,OAAO,GAAG,IAAA,wCAAkB,EAAC,cAAc,EAAE;QACjD,QAAQ;QACR,SAAS;QACT,eAAe;QACf,eAAe;QACf,YAAY;KACb,CAAC,CAAC;IACH,mHAAmH;IACnH,IAAA,4BAAe,EAAC,OAAO,CAAC,CAAC;IAEzB,MAAM,GAAG,GAAG,IAAA,iCAAY,EAAC,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,IAAA,6BAAO,EACjE,GAAG,EACH,OAAO,CACR,CAAC;IAEF,OAAO,IAAA,uCAA0B,EAAC,qBAAqB,CAAC,CAAC;AAC3D,CAAC;AA7BD,kCA6BC","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 {\n  arePrivilegesValid,\n  stringifyArrays,\n  registeredAppResponseToApp\n} 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: [Privileges.Geocode, 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  // privileges validation\n  if (!arePrivilegesValid(requestOptions.privileges)) {\n    throw new Error(\"The `privileges` option contains invalid privileges.\");\n  }\n\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,mEAAwE;AACxE,iEAAwD;AAMxD,6CAA2E;AAE3E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACI,KAAK,UAAU,WAAW,CAC/B,cAAmC;IAEnC,eAAe;IACf,MAAM,OAAO,GAAG,IAAA,wCAAkB,EAAC,cAAc,EAAE;QACjD,QAAQ;QACR,SAAS;QACT,eAAe;QACf,eAAe;QACf,YAAY;KACb,CAAC,CAAC;IACH,mHAAmH;IACnH,IAAA,4BAAe,EAAC,OAAO,CAAC,CAAC;IAEzB,MAAM,GAAG,GAAG,IAAA,iCAAY,EAAC,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,IAAA,6BAAO,EACjE,GAAG,EACH,OAAO,CACR,CAAC;IAEF,OAAO,IAAA,uCAA0B,EAAC,qBAAqB,CAAC,CAAC;AAC3D,CAAC;AAxBD,kCAwBC","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: [Privileges.Geocode, 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"]}

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

@@ -1 +1 @@
-{"version":3,"file":"apiKeyType.js","sourceRoot":"","sources":["../../../../src/shared/types/apiKeyType.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  ArcGISIdentityManager,\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\n/**\n * Options to retrieve an API Key.\n */\nexport interface IGetApiKeyOptions extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * {@linkcode ArcGISIdentityManager} authentication.\n   */\n  authentication: ArcGISIdentityManager;\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<\n    IApp,\n    \"client_id\" | \"client_secret\" | \"redirect_uris\" | \"appType\"\n  > {\n  apiKey: string;\n}\n\n/**\n * Return value of {@linkcode createApiKey}, {@linkcode getApiKey}, {@linkcode updateApiKey} representing an API Key entity.\n */\nexport interface IApiKeyResponse extends IApiKeyInfo {\n  /**\n   * Represent item info attached to this API Key.\n   */\n  item: IItem;\n}\n\n/**\n * Options to update an API Key.\n */\nexport interface IUpdateApiKeyOptions extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * {@linkcode ArcGISIdentityManager} authentication.\n   */\n  authentication: ArcGISIdentityManager;\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?: Array<Privileges | `${Privileges}`>;\n}\n\n/**\n * Options to delete an API key.\n */\nexport interface IDeleteApiKeyOption extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * {@linkcode ArcGISIdentityManager} authentication.\n   */\n  authentication: ArcGISIdentityManager;\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"]}
+{"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"]}

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

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

package/dist/cjs/shared/types/oAuthType.js.map

@@ -1 +1 @@
-{"version":3,"file":"oAuthType.js","sourceRoot":"","sources":["../../../../src/shared/types/oAuthType.ts"],"names":[],"mappings":"","sourcesContent":["import { IItem } from \"@esri/arcgis-rest-portal\";\nimport {\n  ArcGISIdentityManager,\n  IRequestOptions,\n  ISpatialReference\n} from \"@esri/arcgis-rest-request\";\n\n/**\n * Options to register an OAuth2.0 app.\n */\nexport interface ICreateOAuthAppOption extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * Redirect URIs set for this OAuth2.0 app.\n   */\n  redirect_uris?: string[];\n  /**\n   * {@linkcode ArcGISIdentityManager} authentication.\n   */\n  authentication: ArcGISIdentityManager;\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\n/**\n * Options to retrieve an OAuth2.0 app.\n */\nexport interface IGetOAuthAppOptions extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * {@linkcode ArcGISIdentityManager} authentication.\n   */\n  authentication: ArcGISIdentityManager;\n  /**\n   * itemId of which OAuth2.0 app to be retrieved.\n   */\n  itemId: string;\n}\n\n/**\n * Options to update an OAuth2.0 app.\n */\nexport interface IUpdateOAuthOptions extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * {@linkcode ArcGISIdentityManager} authentication.\n   */\n  authentication: ArcGISIdentityManager;\n  /**\n   * itemId of which OAuth2.0 app to be updated.\n   */\n  itemId: string;\n  /**\n   * Override previous `redirect_uris` if this value is provided.\n   */\n  redirect_uris?: string[];\n}\n\n/**\n * Represent only the OAuth2.0 app related properties from {@linkcode IApp}.\n */\nexport interface IOAuthAppInfo {\n  itemId: string;\n  client_id: string;\n  client_secret: string;\n  redirect_uris: string[];\n  registered: Date;\n  modified: Date;\n}\n\n/**\n * Return value of {@linkcode createOAuthApp}, {@linkcode getOAuthApp}, {@linkcode updateOAuthApp} representing an OAuth2.0 app entity.\n */\nexport interface IOAuthApp extends IOAuthAppInfo {\n  /**\n   * Represent item info attached to this OAuth2.0 app.\n   */\n  item: IItem;\n}\n\n/**\n * Options to delete an OAuth2.0 app.\n */\nexport interface IDeleteOAuthAppOption extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * {@linkcode ArcGISIdentityManager} authentication.\n   */\n  authentication: ArcGISIdentityManager;\n  /**\n   * itemId of which OAuth2.0 app to be removed.\n   */\n  itemId: string;\n}\n\n/**\n * Response of OAuth2.0 app deletion.\n */\nexport interface IDeleteOAuthAppResponse {\n  /**\n   * itemId of which OAuth2.0 app has been removed.\n   */\n  itemId: string;\n  success: boolean;\n}\n"]}
+{"version":3,"file":"oAuthType.js","sourceRoot":"","sources":["../../../../src/shared/types/oAuthType.ts"],"names":[],"mappings":"","sourcesContent":["import { IItem } from \"@esri/arcgis-rest-portal\";\nimport {\n  IAuthenticationManager,\n  IRequestOptions,\n  ISpatialReference\n} from \"@esri/arcgis-rest-request\";\n\n/**\n * Options to register an OAuth2.0 app.\n */\nexport interface ICreateOAuthAppOption extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * Redirect URIs set for this OAuth2.0 app.\n   */\n  redirect_uris?: string[];\n  /**\n   * {@linkcode IAuthenticationManager} authentication.\n   */\n  authentication: IAuthenticationManager;\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\n/**\n * Options to retrieve an OAuth2.0 app.\n */\nexport interface IGetOAuthAppOptions extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * {@linkcode IAuthenticationManager} authentication.\n   */\n  authentication: IAuthenticationManager;\n  /**\n   * itemId of which OAuth2.0 app to be retrieved.\n   */\n  itemId: string;\n}\n\n/**\n * Options to update an OAuth2.0 app.\n */\nexport interface IUpdateOAuthOptions extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * {@linkcode IAuthenticationManager} authentication.\n   */\n  authentication: IAuthenticationManager;\n  /**\n   * itemId of which OAuth2.0 app to be updated.\n   */\n  itemId: string;\n  /**\n   * Override previous `redirect_uris` if this value is provided.\n   */\n  redirect_uris?: string[];\n}\n\n/**\n * Represent only the OAuth2.0 app related properties from {@linkcode IApp}.\n */\nexport interface IOAuthAppInfo {\n  itemId: string;\n  client_id: string;\n  client_secret: string;\n  redirect_uris: string[];\n  registered: Date;\n  modified: Date;\n}\n\n/**\n * Return value of {@linkcode createOAuthApp}, {@linkcode getOAuthApp}, {@linkcode updateOAuthApp} representing an OAuth2.0 app entity.\n */\nexport interface IOAuthApp extends IOAuthAppInfo {\n  /**\n   * Represent item info attached to this OAuth2.0 app.\n   */\n  item: IItem;\n}\n\n/**\n * Options to delete an OAuth2.0 app.\n */\nexport interface IDeleteOAuthAppOption extends Omit<IRequestOptions, \"params\"> {\n  /**\n   * {@linkcode IAuthenticationManager} authentication.\n   */\n  authentication: IAuthenticationManager;\n  /**\n   * itemId of which OAuth2.0 app to be removed.\n   */\n  itemId: string;\n}\n\n/**\n * Response of OAuth2.0 app deletion.\n */\nexport interface IDeleteOAuthAppResponse {\n  /**\n   * itemId of which OAuth2.0 app has been removed.\n   */\n  itemId: string;\n  success: boolean;\n}\n"]}

package/dist/cjs/updateApiKey.js

@@ -39,20 +39,21 @@ const arcgis_rest_request_1 = require("@esri/arcgis-rest-request");
  * @returns A Promise that will resolve to an {@linkcode IApiKeyResponse} object representing updated API key.
  */
 async function updateApiKey(requestOptions) {
-    // privileges validation
-    if (requestOptions.privileges &&
-        !(0, helpers_js_1.arePrivilegesValid)(requestOptions.privileges)) {
-        throw new Error("The `privileges` option contains invalid privileges.");
-    }
     requestOptions.httpMethod = "POST";
-    // get app
     const baseRequestOptions = (0, helpers_js_1.extractBaseRequestOptions)(requestOptions); // get base requestOptions snapshot
+    /**
+     * step 1: update expiration dates if provided. Build the object up to avoid overwriting any existing properties.
+     */
+    if (requestOptions.apiToken1ExpirationDate ||
+        requestOptions.apiToken2ExpirationDate) {
+        const updateParams = (0, helpers_js_1.buildExpirationDateParams)(requestOptions);
+        await (0, arcgis_rest_portal_1.updateItem)(Object.assign(Object.assign({}, baseRequestOptions), { item: Object.assign({ id: requestOptions.itemId }, updateParams), authentication: requestOptions.authentication }));
+    }
+    /**
+     * step 2: update privileges and httpReferrers if provided. Build the object up to avoid overwriting any existing properties.
+     */
     const getAppOption = Object.assign(Object.assign({}, baseRequestOptions), { authentication: requestOptions.authentication, itemId: requestOptions.itemId });
     const appResponse = await (0, getRegisteredAppInfo_js_1.getRegisteredAppInfo)(getAppOption);
-    // appType must be APIKey to continue
-    if (appResponse.appType !== "apikey" || !("apiKey" in appResponse)) {
-        throw new Error("Item is not an API key.");
-    }
     const clientId = appResponse.client_id;
     const options = (0, arcgis_rest_request_1.appendCustomParams)(Object.assign(Object.assign({}, appResponse), requestOptions), // object with the custom params to look in
     ["privileges", "httpReferrers"] // keys you want copied to the params object
@@ -63,9 +64,19 @@ async function updateApiKey(requestOptions) {
     const url = (0, arcgis_rest_portal_1.getPortalUrl)(options) + `/oauth2/apps/${clientId}/update`;
     // Raw response from `/oauth2/apps/${clientId}/update`, apiKey not included because key is same.
     const updateResponse = await (0, arcgis_rest_request_1.request)(url, Object.assign(Object.assign({}, options), { authentication: requestOptions.authentication }));
-    const app = (0, helpers_js_1.registeredAppResponseToApp)(Object.assign(Object.assign({}, updateResponse), { apiKey: appResponse.apiKey }));
-    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.appToApiKeyProperties)(app)), { item: itemInfo });
+    /**
+     * step 3: get the updated item info to return to the user.
+     */
+    const updatedItemInfo = await (0, arcgis_rest_portal_1.getItem)(requestOptions.itemId, Object.assign(Object.assign({}, baseRequestOptions), { authentication: requestOptions.authentication, params: { f: "json" } }));
+    /**
+     * step 4: generate tokens if requested
+     */
+    const generatedTokens = await (0, helpers_js_1.generateApiKeyTokens)(requestOptions.itemId, (0, helpers_js_1.generateOptionsToSlots)(requestOptions.generateToken1, requestOptions.generateToken2), Object.assign(Object.assign({}, baseRequestOptions), { authentication: requestOptions.authentication }));
+    /**
+     * step 5: get updated registered app info
+     */
+    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,oDAM6B;AAC7B,iEAAiE;AACjE,mEAAwE;AAOxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACI,KAAK,UAAU,YAAY,CAChC,cAAoC;IAEpC,wBAAwB;IACxB,IACE,cAAc,CAAC,UAAU;QACzB,CAAC,IAAA,+BAAkB,EAAC,cAAc,CAAC,UAAU,CAAC,EAC9C;QACA,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;KACzE;IAED,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC;IAEnC,UAAU;IACV,MAAM,kBAAkB,GAAG,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,qCAAqC;IACrC,IAAI,WAAW,CAAC,OAAO,KAAK,QAAQ,IAAI,CAAC,CAAC,QAAQ,IAAI,WAAW,CAAC,EAAE;QAClE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;KAC5C;IAED,MAAM,QAAQ,GAAG,WAAW,CAAC,SAAS,CAAC;IACvC,MAAM,OAAO,GAAG,IAAA,wCAAkB,kCAC3B,WAAW,GAAK,cAAc,GAAI,2CAA2C;IAClF,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,4CAA4C;KAC7E,CAAC;IACF,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC;IAE1B,mHAAmH;IACnH,IAAA,4BAAe,EAAC,OAAO,CAAC,CAAC;IAEzB,MAAM,GAAG,GAAG,IAAA,iCAAY,EAAC,OAAO,CAAC,GAAG,gBAAgB,QAAQ,SAAS,CAAC;IAEtE,gGAAgG;IAChG,MAAM,cAAc,GAA2B,MAAM,IAAA,6BAAO,EAAC,GAAG,kCAC3D,OAAO,KACV,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH,MAAM,GAAG,GAAS,IAAA,uCAA0B,kCACvC,cAAc,KACjB,MAAM,EAAE,WAAW,CAAC,MAAM,IAC1B,CAAC;IAEH,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,kCAAqB,EAAC,GAAG,CAAC,KAC7B,IAAI,EAAE,QAAQ,IACd;AACJ,CAAC;AA7DD,oCA6DC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  IApiKeyResponse,\n  IUpdateApiKeyOptions\n} from \"./shared/types/apiKeyType.js\";\nimport { getRegisteredAppInfo } from \"./shared/getRegisteredAppInfo.js\";\nimport {\n  appToApiKeyProperties,\n  extractBaseRequestOptions,\n  arePrivilegesValid,\n  stringifyArrays,\n  registeredAppResponseToApp\n} from \"./shared/helpers.js\";\nimport { getItem, getPortalUrl } from \"@esri/arcgis-rest-portal\";\nimport { appendCustomParams, request } from \"@esri/arcgis-rest-request\";\nimport {\n  IApp,\n  IGetAppInfoOptions,\n  IRegisteredAppResponse\n} from \"./shared/types/appType.js\";\n\n/**\n * Used to update an API key.\n *\n * Notes about `privileges` and `httpReferrers` options:\n * 1. Provided option will override corresponding old option.\n * 2. Unprovided option will not trigger corresponding option updates.\n *\n * ```js\n * import { updateApiKey, IApiKeyResponse } from '@esri/arcgis-rest-developer-credentials';\n * import { ArcGISIdentityManager } from \"@esri/arcgis-rest-request\";\n *\n * const authSession: ArcGISIdentityManager = await ArcGISIdentityManager.signIn({\n *   username: \"xyz_usrName\",\n *   password: \"xyz_pw\"\n * });\n *\n * updateApiKey({\n *   itemId: \"xyz_itemId\",\n *   privileges: [Privileges.Geocode],\n *   httpReferrers: [], // httpReferrers will be set to be empty\n *   authentication: authSession\n * }).then((updatedAPIKey: IApiKeyResponse) => {\n *   // => {apiKey: \"xyz_key\", item: {tags: [\"xyz_tag1\", \"xyz_tag2\"], ...}, ...}\n * }).catch(e => {\n *   // => an exception object\n * });\n * ```\n *\n * @param requestOptions - Options for {@linkcode updateApiKey | updateApiKey()}, including `itemId` of which API key to be operated on, optional new `privileges`, optional new `httpReferrers` and an {@linkcode ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IApiKeyResponse} object representing updated API key.\n */\nexport async function updateApiKey(\n  requestOptions: IUpdateApiKeyOptions\n): Promise<IApiKeyResponse> {\n  // privileges validation\n  if (\n    requestOptions.privileges &&\n    !arePrivilegesValid(requestOptions.privileges)\n  ) {\n    throw new Error(\"The `privileges` option contains invalid privileges.\");\n  }\n\n  requestOptions.httpMethod = \"POST\";\n\n  // get app\n  const baseRequestOptions = extractBaseRequestOptions(requestOptions); // get base requestOptions snapshot\n  const getAppOption: IGetAppInfoOptions = {\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication,\n    itemId: requestOptions.itemId\n  };\n\n  const appResponse = await getRegisteredAppInfo(getAppOption);\n\n  // appType must be APIKey to continue\n  if (appResponse.appType !== \"apikey\" || !(\"apiKey\" in appResponse)) {\n    throw new Error(\"Item is not an API key.\");\n  }\n\n  const clientId = appResponse.client_id;\n  const options = appendCustomParams(\n    { ...appResponse, ...requestOptions }, // object with the custom params to look in\n    [\"privileges\", \"httpReferrers\"] // keys you want copied to the params object\n  );\n  options.params.f = \"json\";\n\n  // encode special params value (e.g. array type...) in advance in order to make encodeQueryString() works correctly\n  stringifyArrays(options);\n\n  const url = getPortalUrl(options) + `/oauth2/apps/${clientId}/update`;\n\n  // Raw response from `/oauth2/apps/${clientId}/update`, apiKey not included because key is same.\n  const updateResponse: IRegisteredAppResponse = await request(url, {\n    ...options,\n    authentication: requestOptions.authentication\n  });\n\n  const app: IApp = registeredAppResponseToApp({\n    ...updateResponse,\n    apiKey: appResponse.apiKey\n  });\n\n  const itemInfo = await getItem(requestOptions.itemId, {\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication,\n    params: { f: \"json\" }\n  });\n\n  return {\n    ...appToApiKeyProperties(app),\n    item: itemInfo\n  };\n}\n"]}
+{"version":3,"file":"updateApiKey.js","sourceRoot":"","sources":["../../src/updateApiKey.ts"],"names":[],"mappings":";AAAA;gBACgB;;;AAMhB,8EAAwE;AACxE,oDAQ6B;AAC7B,iEAA6E;AAC7E,mEAAwE;AAOxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;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,MAAM,YAAY,mCACb,kBAAkB,KACrB,cAAc,EAAE,cAAc,CAAC,cAAc,EAC7C,MAAM,EAAE,cAAc,CAAC,MAAM,GAC9B,CAAC;IACF,MAAM,WAAW,GAAG,MAAM,IAAA,8CAAoB,EAAC,YAAY,CAAC,CAAC;IAC7D,MAAM,QAAQ,GAAG,WAAW,CAAC,SAAS,CAAC;IACvC,MAAM,OAAO,GAAG,IAAA,wCAAkB,kCAC3B,WAAW,GAAK,cAAc,GAAI,2CAA2C;IAClF,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,4CAA4C;KAC7E,CAAC;IACF,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC;IAE1B,mHAAmH;IACnH,IAAA,4BAAe,EAAC,OAAO,CAAC,CAAC;IAEzB,MAAM,GAAG,GAAG,IAAA,iCAAY,EAAC,OAAO,CAAC,GAAG,gBAAgB,QAAQ,SAAS,CAAC;IAEtE,gGAAgG;IAChG,MAAM,cAAc,GAA2B,MAAM,IAAA,6BAAO,EAAC,GAAG,kCAC3D,OAAO,KACV,cAAc,EAAE,cAAc,CAAC,cAAc,IAC7C,CAAC;IAEH;;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;AAzFD,oCAyFC","sourcesContent":["/* Copyright (c) 2023 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  IApiKeyResponse,\n  IUpdateApiKeyOptions\n} from \"./shared/types/apiKeyType.js\";\nimport { getRegisteredAppInfo } from \"./shared/getRegisteredAppInfo.js\";\nimport {\n  appToApiKeyProperties,\n  extractBaseRequestOptions,\n  stringifyArrays,\n  registeredAppResponseToApp,\n  generateApiKeyTokens,\n  generateOptionsToSlots,\n  buildExpirationDateParams\n} from \"./shared/helpers.js\";\nimport { getItem, getPortalUrl, updateItem } from \"@esri/arcgis-rest-portal\";\nimport { appendCustomParams, request } from \"@esri/arcgis-rest-request\";\nimport {\n  IApp,\n  IGetAppInfoOptions,\n  IRegisteredAppResponse\n} from \"./shared/types/appType.js\";\n\n/**\n * Used to update an API key.\n *\n * Notes about `privileges` and `httpReferrers` options:\n * 1. Provided option will override corresponding old option.\n * 2. Unprovided option will not trigger corresponding option updates.\n *\n * ```js\n * import { updateApiKey, IApiKeyResponse } from '@esri/arcgis-rest-developer-credentials';\n * import { ArcGISIdentityManager } from \"@esri/arcgis-rest-request\";\n *\n * const authSession: ArcGISIdentityManager = await ArcGISIdentityManager.signIn({\n *   username: \"xyz_usrName\",\n *   password: \"xyz_pw\"\n * });\n *\n * updateApiKey({\n *   itemId: \"xyz_itemId\",\n *   privileges: [Privileges.Geocode],\n *   httpReferrers: [], // httpReferrers will be set to be empty\n *   authentication: authSession\n * }).then((updatedAPIKey: IApiKeyResponse) => {\n *   // => {apiKey: \"xyz_key\", item: {tags: [\"xyz_tag1\", \"xyz_tag2\"], ...}, ...}\n * }).catch(e => {\n *   // => an exception object\n * });\n * ```\n *\n * @param requestOptions - Options for {@linkcode updateApiKey | updateApiKey()}, including `itemId` of which API key to be operated on, optional new `privileges`, optional new `httpReferrers` and an {@linkcode ArcGISIdentityManager} authentication session.\n * @returns A Promise that will resolve to an {@linkcode IApiKeyResponse} object representing updated API key.\n */\nexport async function updateApiKey(\n  requestOptions: IUpdateApiKeyOptions\n): Promise<IApiKeyResponse> {\n  requestOptions.httpMethod = \"POST\";\n  const baseRequestOptions = extractBaseRequestOptions(requestOptions); // get base requestOptions snapshot\n\n  /**\n   * step 1: update expiration dates if provided. Build the object up to avoid overwriting any existing properties.\n   */\n  if (\n    requestOptions.apiToken1ExpirationDate ||\n    requestOptions.apiToken2ExpirationDate\n  ) {\n    const updateParams = buildExpirationDateParams(requestOptions);\n    await updateItem({\n      ...baseRequestOptions,\n      item: {\n        id: requestOptions.itemId,\n        ...updateParams\n      },\n      authentication: requestOptions.authentication\n    });\n  }\n\n  /**\n   * step 2: update privileges and httpReferrers if provided. Build the object up to avoid overwriting any existing properties.\n   */\n  const getAppOption: IGetAppInfoOptions = {\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication,\n    itemId: requestOptions.itemId\n  };\n  const appResponse = await getRegisteredAppInfo(getAppOption);\n  const clientId = appResponse.client_id;\n  const options = appendCustomParams(\n    { ...appResponse, ...requestOptions }, // object with the custom params to look in\n    [\"privileges\", \"httpReferrers\"] // keys you want copied to the params object\n  );\n  options.params.f = \"json\";\n\n  // encode special params value (e.g. array type...) in advance in order to make encodeQueryString() works correctly\n  stringifyArrays(options);\n\n  const url = getPortalUrl(options) + `/oauth2/apps/${clientId}/update`;\n\n  // Raw response from `/oauth2/apps/${clientId}/update`, apiKey not included because key is same.\n  const updateResponse: IRegisteredAppResponse = await request(url, {\n    ...options,\n    authentication: requestOptions.authentication\n  });\n\n  /**\n   * step 3: get the updated item info to return to the user.\n   */\n  const updatedItemInfo = await getItem(requestOptions.itemId, {\n    ...baseRequestOptions,\n    authentication: requestOptions.authentication,\n    params: { f: \"json\" }\n  });\n\n  /**\n   * step 4: generate tokens if requested\n   */\n  const generatedTokens = await generateApiKeyTokens(\n    requestOptions.itemId,\n    generateOptionsToSlots(\n      requestOptions.generateToken1,\n      requestOptions.generateToken2\n    ),\n    {\n      ...baseRequestOptions,\n      authentication: requestOptions.authentication\n    }\n  );\n\n  /**\n   * step 5: get updated registered app info\n   */\n  const updatedRegisteredAppResponse = await getRegisteredAppInfo({\n    ...baseRequestOptions,\n    itemId: requestOptions.itemId,\n    authentication: requestOptions.authentication\n  });\n\n  return {\n    ...generatedTokens,\n    ...appToApiKeyProperties(updatedRegisteredAppResponse),\n    item: updatedItemInfo\n  };\n}\n"]}

package/dist/esm/createApiKey.d.ts

@@ -15,7 +15,7 @@ import { IApiKeyResponse, ICreateApiKeyOptions } from "./shared/types/apiKeyType
  *   title: "xyz_title",
  *   description: "xyz_desc",
  *   tags: ["xyz_tag1", "xyz_tag2"],
- *   privileges: [Privileges.Geocode, Privileges.FeatureReport],
+ *   privileges: ["premium:user:networkanalysis:routing"],
  *   authentication: authSession
  * }).then((registeredAPIKey: IApiKeyResponse) => {
  *   // => {apiKey: "xyz_key", item: {tags: ["xyz_tag1", "xyz_tag2"], ...}, ...}