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

package/dist/esm/shared/helpers.js

@@ -1,9 +1,4 @@
-import { Privileges } from "./enum/privileges.js";
-/**
- * @internal
- * Used to check privileges validity.
- */
-export const arePrivilegesValid = (privileges) => privileges.every((element) => Object.values(Privileges).includes(element));
+import { generateApiKeyToken } from "./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.
@@ -25,7 +20,8 @@ export function registeredAppResponseToApp(response) {
         "apnsProdCert",
         "apnsSandboxCert",
         "gcmApiKey",
-        "isBeta"
+        "isBeta",
+        "customAppLoginShowTriage"
     ];
     const dateKeys = ["modified", "registered"];
     return Object.keys(response)
@@ -45,13 +41,11 @@ export function registeredAppResponseToApp(response) {
  * Used to convert {@linkcode IApp} to {@linkcode IApiKeyInfo} only if `appType` is "apikey".
  */
 export 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;
 }
 /**
@@ -59,12 +53,14 @@ export function appToApiKeyProperties(response) {
  * Used to convert {@linkcode IApp} to {@linkcode IOAuthAppInfo}.
  */
 export 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;
 }
 /**
@@ -97,4 +93,82 @@ export function filterKeys(object, includedKeys) {
         return obj;
     }, {});
 }
+/**
+ * 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.
+ */
+export function slotForKey(key) {
+    const slot = parseInt(key.substring(key.length - 10, key.length - 9));
+    if (slot === 1 || slot === 2) {
+        return slot;
+    }
+    return undefined;
+}
+/**
+ * @internal
+ * Used to determine which slot to invalidate a key in given a number or a full or patial key.
+ */
+export function slotForInvalidationKey(param) {
+    if (param === 1 || param === 2) {
+        return param;
+    }
+    if (typeof param !== "string") {
+        return undefined;
+    }
+    const fullKeySlot = slotForKey(param);
+    if (fullKeySlot) {
+        return fullKeySlot;
+    }
+}
+/**
+ * @internal
+ * Used to generate tokens in slot 1 and/or 2 of an API key.
+ */
+export function generateApiKeyTokens(itemId, slots, requestOptions) {
+    return Promise.all(slots.map((slot) => {
+        return 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;
+        }, {});
+    });
+}
+/**
+ * @internal
+ * Convert boolean flags to an array of slots for {@linkcode generateApiKeyTokens}.
+ */
+export function generateOptionsToSlots(generateToken1, generateToken2) {
+    const slots = [];
+    if (generateToken1) {
+        slots.push(1);
+    }
+    if (generateToken2) {
+        slots.push(2);
+    }
+    return slots;
+}
+/**
+ * @internal
+ * Build params for updating expiration dates
+ */
+export 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;
+}
 //# sourceMappingURL=helpers.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../src/shared/helpers.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAKlD;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,UAA+C,EACtC,EAAE,CACX,UAAU,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE,CAC3B,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,OAAc,CAAC,CACnD,CAAC;AAEJ;;;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;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;AAED;;;GAGG;AACH,MAAM,UAAU,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;AAED;;;GAGG;AACH,MAAM,UAAU,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;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","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,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"]}

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

@@ -23,7 +23,7 @@ import { IApp, IRegisterAppOptions } from "./types/appType.js";
  *   appType: "multiple",
  *   redirect_uris: ["http://localhost:3000/"],
  *   httpReferrers: ["http://localhost:3000/"],
- *   privileges: [Privileges.Geocode, Privileges.FeatureReport],
+ *   privileges: ["premium:user:geocode:temporary", Privileges.FeatureReport],
  *   authentication: authSession
  * }).then((registeredApp: IApp) => {
  *   // => {client_id: "xyz_id", client_secret: "xyz_secret", ...}

package/dist/esm/shared/registerApp.js

@@ -2,7 +2,7 @@
  * Apache-2.0 */
 import { request, appendCustomParams } from "@esri/arcgis-rest-request";
 import { getPortalUrl } from "@esri/arcgis-rest-portal";
-import { arePrivilegesValid, stringifyArrays, registeredAppResponseToApp } from "./helpers.js";
+import { stringifyArrays, registeredAppResponseToApp } from "./helpers.js";
 /**
  * Used to register an app. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/register-app.htm) for more information.
  *
@@ -27,7 +27,7 @@ import { arePrivilegesValid, stringifyArrays, registeredAppResponseToApp } from
  *   appType: "multiple",
  *   redirect_uris: ["http://localhost:3000/"],
  *   httpReferrers: ["http://localhost:3000/"],
- *   privileges: [Privileges.Geocode, Privileges.FeatureReport],
+ *   privileges: ["premium:user:geocode:temporary", Privileges.FeatureReport],
  *   authentication: authSession
  * }).then((registeredApp: IApp) => {
  *   // => {client_id: "xyz_id", client_secret: "xyz_secret", ...}
@@ -40,10 +40,6 @@ import { arePrivilegesValid, stringifyArrays, registeredAppResponseToApp } from
  * @returns A Promise that will resolve to an {@linkcode IApp} object representing the newly registered app.
  */
 export async function registerApp(requestOptions) {
-    // privileges validation
-    if (!arePrivilegesValid(requestOptions.privileges)) {
-        throw new Error("The `privileges` option contains invalid privileges.");
-    }
     // build params
     const options = appendCustomParams(requestOptions, [
         "itemId",

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,EACL,kBAAkB,EAClB,eAAe,EACf,0BAA0B,EAC3B,MAAM,cAAc,CAAC;AAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,cAAmC;IAEnC,wBAAwB;IACxB,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE;QAClD,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;KACzE;IAED,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 {\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,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"]}

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

@@ -1,6 +1,5 @@
 import { IAuthenticationManager, IRequestOptions, ISpatialReference } from "@esri/arcgis-rest-request";
 import { IRegisterAppOptions, IApp } from "./appType.js";
-import { Privileges } from "../enum/privileges.js";
 import { IItem } from "@esri/arcgis-rest-portal";
 /**
  * Options to register an API Key.
@@ -20,6 +19,22 @@ export interface ICreateApiKeyOptions extends Omit<IRegisterAppOptions, "itemId"
     properties?: any;
     url?: string;
     tags?: string[];
+    /**
+     * Expiration date of the access token in slot 1 of this API Key.
+     */
+    apiToken1ExpirationDate?: Date;
+    /**
+     * Expiration date of the access token in slot 2 of this API Key.
+     */
+    apiToken2ExpirationDate?: Date;
+    /**
+     * Generate a new access token in slot 1 of this API. Will override and invalidate any existing token.
+     */
+    generateToken1?: boolean;
+    /**
+     * Generate a new access token in slot 2 of this API. Will override and invalidate any existing token.
+     */
+    generateToken2?: boolean;
 }
 /**
  * Options to retrieve an API Key.
@@ -37,17 +52,18 @@ export interface IGetApiKeyOptions extends Omit<IRequestOptions, "params"> {
 /**
  * Represent only the API key related properties from {@linkcode IApp}.
  */
-export interface IApiKeyInfo extends Omit<IApp, "client_id" | "client_secret" | "redirect_uris" | "appType"> {
-    apiKey: string;
+export interface IApiKeyInfo extends Omit<IApp, "client_secret" | "redirect_uris" | "appType"> {
 }
 /**
- * Return value of {@linkcode createApiKey}, {@linkcode getApiKey}, {@linkcode updateApiKey} representing an API Key entity.
+ * 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`.
  */
 export interface IApiKeyResponse extends IApiKeyInfo {
     /**
      * Represent item info attached to this API Key.
      */
     item: IItem;
+    accessToken1?: null | string;
+    accessToken2?: null | string;
 }
 /**
  * Options to update an API Key.
@@ -68,7 +84,23 @@ export interface IUpdateApiKeyOptions extends Omit<IRequestOptions, "params"> {
     /**
      * Override previous `privileges` if this value is provided.
      */
-    privileges?: Array<Privileges | `${Privileges}`>;
+    privileges?: string[];
+    /**
+     * Expiration date of the access token in slot 1 of this API Key.
+     */
+    apiToken1ExpirationDate?: Date;
+    /**
+     * Expiration date of the access token in slot 2 of this API Key.
+     */
+    apiToken2ExpirationDate?: Date;
+    /**
+     * Generate a new access token in slot 1 of this API. Will override and invalidate any existing token.
+     */
+    generateToken1?: boolean;
+    /**
+     * Generate a new access token in slot 2 of this API. Will override and invalidate any existing token.
+     */
+    generateToken2?: boolean;
 }
 /**
  * Options to delete an API key.
@@ -93,3 +125,20 @@ export interface IDeleteApiKeyResponse {
     itemId: string;
     success: boolean;
 }
+export interface IInvalidateApiKeyOptions extends Omit<IRequestOptions, "params"> {
+    /**
+     * {@linkcode IAuthenticationManager} authentication.
+     */
+    authentication: IAuthenticationManager;
+    /**
+     * itemId of the item of the API key to be revoked.
+     */
+    itemId: string;
+    /**
+     * The API key to be revoked. The full or partial API key or the slot number (1 or 2) can be provided.
+     */
+    apiKey?: string | 1 | 2;
+}
+export interface IInvalidateApiKeyResponse {
+    success: boolean;
+}

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\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<\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 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?: Array<Privileges | `${Privileges}`>;\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"]}
+{"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"]}

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

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

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

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

package/dist/esm/updateApiKey.d.ts

@@ -15,13 +15,19 @@ import { IApiKeyResponse, IUpdateApiKeyOptions } from "./shared/types/apiKeyType
  *   password: "xyz_pw"
  * });
  *
+ * const threeDaysFromToday = new Date();
+ * threeDaysFromToday.setDate(threeDaysFromToday.getDate() + 3);
+ * threeDaysFromToday.setHours(23, 59, 59, 999);
+ *
  * updateApiKey({
  *   itemId: "xyz_itemId",
- *   privileges: [Privileges.Geocode],
+ *   privileges: ["premium:user:geocode:temporary"],
  *   httpReferrers: [], // httpReferrers will be set to be empty
  *   authentication: authSession
+ *   generateToken1: true, // optional,generate a new token
+ *   apiToken1ExpirationDate: threeDaysFromToday  // optional, update expiration date
  * }).then((updatedAPIKey: IApiKeyResponse) => {
- *   // => {apiKey: "xyz_key", item: {tags: ["xyz_tag1", "xyz_tag2"], ...}, ...}
+ *   // => {accessToken1: "xyz_key", item: {tags: ["xyz_tag1", "xyz_tag2"], ...}, ...}
  * }).catch(e => {
  *   // => an exception object
  * });

package/dist/esm/updateApiKey.js

@@ -1,8 +1,8 @@
 /* Copyright (c) 2023 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 import { getRegisteredAppInfo } from "./shared/getRegisteredAppInfo.js";
-import { appToApiKeyProperties, extractBaseRequestOptions, arePrivilegesValid, stringifyArrays, registeredAppResponseToApp } from "./shared/helpers.js";
-import { getItem, getPortalUrl } from "@esri/arcgis-rest-portal";
+import { appToApiKeyProperties, extractBaseRequestOptions, stringifyArrays, generateApiKeyTokens, generateOptionsToSlots, buildExpirationDateParams } from "./shared/helpers.js";
+import { getItem, getPortalUrl, updateItem } from "@esri/arcgis-rest-portal";
 import { appendCustomParams, request } from "@esri/arcgis-rest-request";
 /**
  * Used to update an API key.
@@ -20,13 +20,19 @@ import { appendCustomParams, request } from "@esri/arcgis-rest-request";
  *   password: "xyz_pw"
  * });
  *
+ * const threeDaysFromToday = new Date();
+ * threeDaysFromToday.setDate(threeDaysFromToday.getDate() + 3);
+ * threeDaysFromToday.setHours(23, 59, 59, 999);
+ *
  * updateApiKey({
  *   itemId: "xyz_itemId",
- *   privileges: [Privileges.Geocode],
+ *   privileges: ["premium:user:geocode:temporary"],
  *   httpReferrers: [], // httpReferrers will be set to be empty
  *   authentication: authSession
+ *   generateToken1: true, // optional,generate a new token
+ *   apiToken1ExpirationDate: threeDaysFromToday  // optional, update expiration date
  * }).then((updatedAPIKey: IApiKeyResponse) => {
- *   // => {apiKey: "xyz_key", item: {tags: ["xyz_tag1", "xyz_tag2"], ...}, ...}
+ *   // => {accessToken1: "xyz_key", item: {tags: ["xyz_tag1", "xyz_tag2"], ...}, ...}
  * }).catch(e => {
  *   // => an exception object
  * });
@@ -36,32 +42,45 @@ import { appendCustomParams, request } from "@esri/arcgis-rest-request";
  * @returns A Promise that will resolve to an {@linkcode IApiKeyResponse} object representing updated API key.
  */
 export async function updateApiKey(requestOptions) {
-    // privileges validation
-    if (requestOptions.privileges &&
-        !arePrivilegesValid(requestOptions.privileges)) {
-        throw new Error("The `privileges` option contains invalid privileges.");
-    }
     requestOptions.httpMethod = "POST";
-    // get app
     const baseRequestOptions = extractBaseRequestOptions(requestOptions); // get base requestOptions snapshot
-    const getAppOption = Object.assign(Object.assign({}, baseRequestOptions), { authentication: requestOptions.authentication, itemId: requestOptions.itemId });
-    const appResponse = await getRegisteredAppInfo(getAppOption);
-    // appType must be APIKey to continue
-    if (appResponse.appType !== "apikey" || !("apiKey" in appResponse)) {
-        throw new Error("Item is not an API key.");
+    /**
+     * step 1: update expiration dates if provided. Build the object up to avoid overwriting any existing properties.
+     */
+    if (requestOptions.apiToken1ExpirationDate ||
+        requestOptions.apiToken2ExpirationDate) {
+        const updateParams = buildExpirationDateParams(requestOptions);
+        await updateItem(Object.assign(Object.assign({}, baseRequestOptions), { item: Object.assign({ id: requestOptions.itemId }, updateParams), authentication: requestOptions.authentication }));
+    }
+    /**
+     * step 2: update privileges and httpReferrers if provided. Build the object up to avoid overwriting any existing properties.
+     */
+    if (requestOptions.privileges || requestOptions.httpReferrers) {
+        const getAppOption = Object.assign(Object.assign({}, baseRequestOptions), { authentication: requestOptions.authentication, itemId: requestOptions.itemId });
+        const appResponse = await getRegisteredAppInfo(getAppOption);
+        const clientId = appResponse.client_id;
+        const options = appendCustomParams(Object.assign(Object.assign({}, appResponse), requestOptions), // object with the custom params to look in
+        ["privileges", "httpReferrers"] // keys you want copied to the params object
+        );
+        options.params.f = "json";
+        // encode special params value (e.g. array type...) in advance in order to make encodeQueryString() works correctly
+        stringifyArrays(options);
+        const url = getPortalUrl(options) + `/oauth2/apps/${clientId}/update`;
+        // Raw response from `/oauth2/apps/${clientId}/update`, apiKey not included because key is same.
+        const updateResponse = await request(url, Object.assign(Object.assign({}, options), { authentication: requestOptions.authentication }));
     }
-    const clientId = appResponse.client_id;
-    const options = appendCustomParams(Object.assign(Object.assign({}, appResponse), requestOptions), // object with the custom params to look in
-    ["privileges", "httpReferrers"] // keys you want copied to the params object
-    );
-    options.params.f = "json";
-    // encode special params value (e.g. array type...) in advance in order to make encodeQueryString() works correctly
-    stringifyArrays(options);
-    const url = getPortalUrl(options) + `/oauth2/apps/${clientId}/update`;
-    // Raw response from `/oauth2/apps/${clientId}/update`, apiKey not included because key is same.
-    const updateResponse = await request(url, Object.assign(Object.assign({}, options), { authentication: requestOptions.authentication }));
-    const app = registeredAppResponseToApp(Object.assign(Object.assign({}, updateResponse), { apiKey: appResponse.apiKey }));
-    const itemInfo = await getItem(requestOptions.itemId, Object.assign(Object.assign({}, baseRequestOptions), { authentication: requestOptions.authentication, params: { f: "json" } }));
-    return Object.assign(Object.assign({}, appToApiKeyProperties(app)), { item: itemInfo });
+    /**
+     * step 3: get the updated item info to return to the user.
+     */
+    const updatedItemInfo = await getItem(requestOptions.itemId, Object.assign(Object.assign({}, baseRequestOptions), { authentication: requestOptions.authentication, params: { f: "json" } }));
+    /**
+     * step 4: generate tokens if requested
+     */
+    const generatedTokens = await generateApiKeyTokens(requestOptions.itemId, generateOptionsToSlots(requestOptions.generateToken1, requestOptions.generateToken2), Object.assign(Object.assign({}, baseRequestOptions), { authentication: requestOptions.authentication }));
+    /**
+     * step 5: get updated registered app info
+     */
+    const updatedRegisteredAppResponse = await getRegisteredAppInfo(Object.assign(Object.assign({}, baseRequestOptions), { itemId: requestOptions.itemId, authentication: requestOptions.authentication }));
+    return Object.assign(Object.assign(Object.assign({}, generatedTokens), appToApiKeyProperties(updatedRegisteredAppResponse)), { item: updatedItemInfo });
 }
 //# sourceMappingURL=updateApiKey.js.map

package/dist/esm/updateApiKey.js.map

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

package/package.json

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

package/dist/cjs/deleteApiKey.js

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