npm - @art-suite/art-core-ts-communication-status - Versions diffs - 0.3.9 → 0.4.2 - Mend

@art-suite/art-core-ts-communication-status 0.3.9 → 0.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/dist/index.cjs CHANGED Viewed

@@ -23,9 +23,13 @@ __export(index_exports, {
   aborted: () => aborted,
   clientFailure: () => clientFailure,
   clientFailureNotAuthorized: () => clientFailureNotAuthorized,
+  communicationStatuses: () => communicationStatuses,
   failure: () => failure,
   getCommunicationStatus: () => getCommunicationStatus,
   getCommunicationStatusDetails: () => getCommunicationStatusDetails,
+  getCommunicationStatusFromHttpStatus: () => getCommunicationStatusFromHttpStatus,
+  getCommunicationStatusFromHttpStatusOrUndefined: () => getCommunicationStatusFromHttpStatusOrUndefined,
+  getCommunicationStatusOrUndefined: () => getCommunicationStatusOrUndefined,
   getHttpStatus: () => getHttpStatus,
   isAborted: () => isAborted,
   isClientFailure: () => isClientFailure,
@@ -50,7 +54,19 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
-// src/CommunicationStatus.ts
+// src/CommunicationStatusConsts.ts
+var success = "success";
+var missing = "missing";
+var clientFailure = "clientFailure";
+var clientFailureNotAuthorized = "clientFailureNotAuthorized";
+var serverFailure = "serverFailure";
+var networkFailure = "networkFailure";
+var aborted = "aborted";
+var pending = "pending";
+var failure = "failure";
+var timeoutFailure = "timeoutFailure";
+// src/CommunicationStatusTypes.ts
 var communicationStatuses = {
   success: { httpStatus: 200 },
   missing: { httpStatus: 404, failure: true },
@@ -63,17 +79,9 @@ var communicationStatuses = {
   failure: { httpStatus: 500, failure: true },
   timeoutFailure: { failure: true }
 };
-var statusRegex = /^(success|missing|clientFailure|clientFailureNotAuthorized|serverFailure|networkFailure|aborted|pending|failure|timeoutFailure)$/;
-var success = "success";
-var missing = "missing";
-var clientFailure = "clientFailure";
-var clientFailureNotAuthorized = "clientFailureNotAuthorized";
-var serverFailure = "serverFailure";
-var networkFailure = "networkFailure";
-var aborted = "aborted";
-var pending = "pending";
-var failure = "failure";
-var timeoutFailure = "timeoutFailure";
+var statusRegex = new RegExp(`^(${Object.keys(communicationStatuses).join("|")})$`);
+// src/CommunicationStatusTests.ts
 var isSuccess = (status) => status === success;
 var isFailure = (status) => !!communicationStatuses[status]?.failure;
 var isClientFailure = (status) => !!communicationStatuses[status]?.clientFailure;
@@ -87,64 +95,87 @@ var isPending = (status) => status === pending;
 var isTimeout = (status) => status === timeoutFailure;
 var isRetryableFailure = (status) => isNetworkFailure(status) || isTimeout(status) || isAborted(status);
 var isStatusValid = (status) => statusRegex.test(status);
-var getCommunicationStatusDetails = (httpStatus) => {
-  if (!httpStatus) return { status: networkFailure, message: "network failure" };
-  let status;
+// src/CommunicationStatus.ts
+var getCommunicationStatusFromHttpStatusOrUndefined = (httpStatus) => {
   switch (Math.floor(httpStatus / 100)) {
     case 2:
-      status = success;
-      break;
+      return success;
     case 3:
-      status = missing;
-      break;
+      return missing;
     case 4:
       switch (httpStatus) {
         case 401:
         case 403:
         case 407:
         case 451:
-          status = clientFailureNotAuthorized;
-          break;
+          return clientFailureNotAuthorized;
         case 404:
-          status = missing;
-          break;
+          return missing;
         default:
-          status = clientFailure;
+          return clientFailure;
       }
-      break;
     case 5:
       switch (httpStatus) {
         case 502:
         case 503:
         case 504:
-          status = networkFailure;
-          break;
+          return networkFailure;
         case 511:
-          status = clientFailureNotAuthorized;
-          break;
+          return clientFailureNotAuthorized;
         case 501:
-          status = missing;
-          break;
+          return missing;
         // 501 Not Implemented - i.e. it "does not exist" currently - i.e. missing
         case 505:
         // HTTP Version Not Supported - client should change the request
         case 530:
-          status = clientFailure;
-          break;
+          return clientFailure;
         default:
-          status = serverFailure;
-          break;
+          return serverFailure;
       }
-      break;
   }
-  if (!status) throw new Error(`httpStatus ${httpStatus} is not a supported CommunicationStatus.`);
+  return void 0;
+};
+var getCommunicationStatusFromHttpStatus = (httpStatus) => {
+  const status = getCommunicationStatusFromHttpStatusOrUndefined(httpStatus);
+  if (!status) {
+    throw new Error(`httpStatus ${httpStatus} is not a supported CommunicationStatus.`);
+  }
+  return status;
+};
+var getCommunicationStatusDetails = (httpStatus) => {
+  if (!httpStatus) return { status: networkFailure, message: "network failure" };
+  const status = getCommunicationStatusFromHttpStatus(httpStatus);
   return {
     status,
     httpStatus,
     message: `${status} (${httpStatus})`
   };
 };
-var getCommunicationStatus = (httpStatus) => getCommunicationStatusDetails(httpStatus).status;
+var getCommunicationStatusOrUndefined = (status) => {
+  if (status == null) return void 0;
+  if (typeof status === "string") {
+    if (!isStatusValid(status)) {
+      return void 0;
+    }
+    return status;
+  }
+  if (typeof status === "number") {
+    return getCommunicationStatusFromHttpStatusOrUndefined(status);
+  }
+  return void 0;
+};
+var getCommunicationStatus = (status) => {
+  if (status == null) return void 0;
+  if (typeof status === "number") {
+    return getCommunicationStatusFromHttpStatus(status);
+  }
+  const communicationStatus = getCommunicationStatusOrUndefined(status);
+  if (!communicationStatus) {
+    throw new Error(`${status} is not a valid CommunicationStatus.`);
+  }
+  return communicationStatus;
+};
 var getHttpStatus = (status) => {
   const httpStatus = communicationStatuses[status]?.httpStatus;
   if (!httpStatus) throw new Error(`There is no valid HttpStatus for ${status}.`);
@@ -155,9 +186,13 @@ var getHttpStatus = (status) => {
   aborted,
   clientFailure,
   clientFailureNotAuthorized,
+  communicationStatuses,
   failure,
   getCommunicationStatus,
   getCommunicationStatusDetails,
+  getCommunicationStatusFromHttpStatus,
+  getCommunicationStatusFromHttpStatusOrUndefined,
+  getCommunicationStatusOrUndefined,
   getHttpStatus,
   isAborted,
   isClientFailure,

package/dist/index.cjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../src/index.ts","../src/CommunicationStatus.ts"],"sourcesContent":["export * from \"./CommunicationStatus\"","interface CommunicationStatusInfo {\n httpStatus?: number\n failure?: boolean\n clientFailure?: boolean\n serverFailure?: boolean\n}\n\ninterface CommunicationStatuses {\n [key: string]: CommunicationStatusInfo\n}\n\nconst communicationStatuses: CommunicationStatuses = {\n success: { httpStatus: 200 },\n missing: { httpStatus: 404, failure: true },\n clientFailure: { httpStatus: 400, clientFailure: true, failure: true },\n clientFailureNotAuthorized: { httpStatus: 403, clientFailure: true, failure: true },\n serverFailure: { httpStatus: 500, failure: true, serverFailure: true },\n networkFailure: { failure: true },\n aborted: { failure: true },\n pending: {},\n failure: { httpStatus: 500, failure: true },\n timeoutFailure: { failure: true }\n}\n\nexport type CommunicationStatus = \"success\" \| \"missing\" \| \"clientFailure\" \| \"clientFailureNotAuthorized\" \| \"serverFailure\" \| \"networkFailure\" \| \"aborted\" \| \"pending\" \| \"failure\" \| \"timeoutFailure\"\n/*\n RegEx returns true for all valid communication statuses\n /\nexport const statusRegex = /^(success\|missing\|clientFailure\|clientFailureNotAuthorized\|serverFailure\|networkFailure\|aborted\|pending\|failure\|timeoutFailure)$/\n\n// Export status constants\n/\n HTTP 2xx responses\n \n Client Can Automatically:\n * - Process the successful response\n * - Update UI to reflect success\n \n Client Developer Can:\n * - Handle the successful response data\n /\nexport const success: CommunicationStatus = \"success\"\n\n/\n Resource not found\n \n HTTP Status Codes Covered:\n * - 404: Not Found\n \n Client Can Automatically:\n * - notify the user that the resource was not found\n * - prompt the user to request a different resource\n \n Client Developer Can:\n * - fix the bad resource paths\n /\nexport const missing: CommunicationStatus = \"missing\"\n\n/\n Client-side errors; i.e. the client needs to change the request somehow to succeed\n \n HTTP Status Codes Covered:\n * - 400: Bad Request\n * - 401: Unauthorized\n * - 403: Forbidden\n * - 407: Proxy Authentication Required\n * - 409: Conflict\n * - 422: Unprocessable Entity\n \n Client Can Automatically:\n * - Notify the user that the client is experiencing issues\n * - Prompt user to correct invalid input\n \n Client Developer Can:\n * - use isClientFailureNotAuthorized to check for 401/403/407/451\n * - fix the request to avoid the 4xx error\n * - validate input before sending requests\n /\nexport const clientFailure: CommunicationStatus = \"clientFailure\"\n\n/\n Unauthorized requests; i.e. client needs to change the credentials (or the grants for the current credentials) to succeed\n \n HTTP Status Codes Covered:\n * - 401: Unauthorized\n * - 403: Forbidden\n * - 407: Proxy Authentication Required\n * - 451: Unavailable For Legal Reasons\n \n Client Can Automatically:\n * - refresh the request token\n * - prompt the user to re-login\n * - ask the user to contact the administrator for access\n \n Client and Server Developer Can:\n * - fix authorization / authentication bugs\n /\nexport const clientFailureNotAuthorized: CommunicationStatus = \"clientFailureNotAuthorized\"\n\n/\n Server-side errors; i.e. internal server errors\n \n HTTP Status Codes Covered:\n * - 500: Internal Server Error\n * - 502: Bad Gateway\n * - 503: Service Unavailable\n * - 504: Gateway Timeout\n \n Client Can Automatically:\n * - Ask the user to try again later\n * - Notify the user that the server is experiencing issues\n * - Implement automatic retry with backoff\n \n Client Developer: (probably) can't fix\n \n Server Developer Can:\n * - fix the server to avoid the 5xx error\n * - fix server infrastructure to avoid the 5xx error\n /\nexport const serverFailure: CommunicationStatus = \"serverFailure\"\n\n/\n Request fails due to network connectivity issues\n \n HTTP Status Codes Covered: NONE (server was not reachable)\n \n Client Can Automatically:\n * - Prompt the user to fix the network connection\n * - Retry the request when network is available\n * - Monitor network status for recovery\n \n Client Developer Can:\n * - fix bad network constants (like address, ports, etc.)\n * - implement offline-first capabilities\n /\nexport const networkFailure: CommunicationStatus = \"networkFailure\"\n\n/\n Request was cancelled by client\n \n Client Can Automatically:\n * - notify the user that the request was cancelled\n * - prompt the user to try again\n * - cleanup any pending state\n \n Client Developer Can:\n * - fix the client to not abort the request unnecessarily\n * - implement proper cleanup on abort\n /\nexport const aborted: CommunicationStatus = \"aborted\"\n\n/\n Request is in progress\n \n Client Can Automatically:\n * - notify the user that the request is in progress\n * - show the user progress (if available)\n * - allow the user to cancel the request\n \n Client Developer Can:\n * - if \"pending\" was not expected, maybe the client needs to `wait` for the request to complete?\n * - implement proper loading states\n /\nexport const pending: CommunicationStatus = \"pending\"\n\n/\n Any error response (HTTP 4xx/5xx) or network/abort failures\n \n HTTP Status Codes Covered:\n * - 4xx: Client-side errors (except 404)\n * - 5xx: Server-side errors\n * - Network failures\n * - Abort failures\n \n Client Can Automatically:\n * - Show appropriate error message to user\n * - Implement generic error handling\n * - Log errors for debugging\n \n Client Developer Can:\n * - Use more specific is* functions for targeted error handling\n * - Implement proper error recovery strategies\n /\nexport const failure: CommunicationStatus = \"failure\"\n\n/\n Request timed out\n \n Client Can Automatically:\n * - notify the user that the request timed out\n * - try again (automatically or via user action)\n \n Client Developer Can:\n * - fix the client to not timeoutFailure the request\n * - implement proper timeoutFailure handling\n /\nexport const timeoutFailure: CommunicationStatus = \"timeoutFailure\"\n\n// Core status check functions\n/* Returns true for HTTP 2xx responses /\nexport const isSuccess = (status: CommunicationStatus) => status === success\n\n/\n Returns true for any error response (HTTP 4xx/5xx) or network/abort failures\n \n HTTP Status Codes Covered:\n * - 4xx: Client-side errors (except 404)\n * - 5xx: Server-side errors\n * - Network failures\n * - Abort failures\n \n Client Can:\n * - Use a different is* function for more specific checks\n /\nexport const isFailure = (status: CommunicationStatus) => !!communicationStatuses[status]?.failure\n\n/\n Returns true for client-side errors\n \n HTTP Status Codes Covered:\n * - 400: Bad Request\n * - 401: Unauthorized\n * - 403: Forbidden\n * - 407: Proxy Authentication Required\n * - 409: Conflict\n * - 422: Unprocessable Entity\n \n Client Can Automatically:\n * - Notify the user that the client is experiencing issues\n \n Client Developer Can:\n * - use isClientFailureNotAuthorized to check for 401/403/407/451\n * - fix the request to avoid the 4xx error\n/\nexport const isClientFailure = (status: CommunicationStatus) => !!communicationStatuses[status]?.clientFailure\n\n/\n Returns true for server-side errors\n \n HTTP Status Codes Covered:\n * - 500: Internal Server Error\n * - 502: Bad Gateway\n * - 503: Service Unavailable\n * - 504: Gateway Timeout\n \n Client Can Automatically:\n * - Ask the user to try again later\n * - Notify the user that the server is experiencing issues\n \n Client Developer: (probably) can't fix\n \n Server Developer Can:\n * - fix the server to avoid the 5xx error\n * - fix server infrastructure to avoid the 5xx error (e.g. Bad Gateway, Service Unavailable, Gateway Timeout)\n/\nexport const isServerFailure = (status: CommunicationStatus) => !!communicationStatuses[status]?.serverFailure\n\n/\n Returns true when request fails due to network connectivity issues\n \n HTTP Status Codes Covered: NONE (server was not reachable)\n \n Client Can Automatically:\n * - Prompt the user to fix the network connection\n * - Retry the request\n \n Client Developer Can:\n * - fix bad network constants (like address, ports, etc.)\n/\nexport const isNetworkFailure = (status: CommunicationStatus) => status === networkFailure\n\n/* Returns true for server errors, network failures and aborted requests; i.e. the client did nothing wrong (as far as we can tell); client can ask the user to do something OR retry the request /\nexport const isNonClientFailure = (status: CommunicationStatus) => isFailure(status) && !isClientFailure(status)\n\n/\n Returns true for unauthorized requests (not authenticated or not authorized)\n \n HTTP Status Codes Covered:\n * - 401: Unauthorized\n * - 403: Forbidden\n * - 407: Proxy Authentication Required\n * - 451: Unavailable For Legal Reasons\n * - 511: Network Authentication Required\n \n Client Can Automatically:\n * - refresh the request token\n * - prompt the user to re-login\n * - ask the user to contact the administrator for access\n \n Client and Server Developer Can:\n * - fix authorization / authentication bugs\n /\nexport const isClientFailureNotAuthorized = (status: CommunicationStatus) => status === clientFailureNotAuthorized\n\n/\n Returns true when request was cancelled by client\n \n Client Can Automatically:\n * - notify the user that the request was cancelled\n * - prompt the user to try again\n \n Client Developer Can:\n * - fix the client to not abort the request\n /\nexport const isAborted = (status: CommunicationStatus) => status === aborted\n\n/\n Returns true when resource not found / not available\n \n HTTP Status Codes Covered:\n * - 404: Not Found\n * - 501: Not Implemented\n \n Client Can Automatically:\n * - notify the user that the resource was not found\n * - prompt the user to request a different resource\n \n Client Developer Can:\n * - fix the bad resource paths\n /\nexport const isMissing = (status: CommunicationStatus) => status === missing\n\n/\n Returns true while request is in progress\n \n Client Can Automatically:\n * - notify the user that the request is in progress\n * - show the user progress (if available)\n * - allow the user to cancel the request (trigging an \"aborted\" communication status)\n \n Client Developer Can:\n * - if \"pending\" was not expected, maybe the client needs to `wait` for the request to complete?\n /\nexport const isPending = (status: CommunicationStatus) => status === pending\n\n/\n Returns true if the request timed out\n \n Client Can Automatically:\n * - notify the user that the request timed out\n * - try again (automatically or via user action)\n \n Client Developer Can:\n * - extend the timeoutFailure duration\n \n Server Developer Can:\n * - improve server performance and reliability\n /\nexport const isTimeout = (status: CommunicationStatus) => status === timeoutFailure\n\n/\n Returns true if client can safely retry the request\n \n A a clearly-retryable failure:\n \n - network failure\n * - timeoutFailure\n * - aborted\n \n Note: some serverFailures will succeed on retry, but HTTP doesn't return clear indications which ones. To be safe, the client should not retry serverFailures indiscriminately.\n \n Client and Server Devs can\n * - investigate network, client and server performance and reliability issues\n /\nexport const isRetryableFailure = (status: CommunicationStatus) => isNetworkFailure(status) \|\| isTimeout(status) \|\| isAborted(status)\n\n/\n Returns true if the status is a valid communication status\n /\nexport const isStatusValid = (status: string) => statusRegex.test(status);\n\ninterface CommunicationStatusDetails {\n status: CommunicationStatus\n httpStatus?: number\n message: string\n}\n\n/\n Returns CommunicationStatusDetails {status, httpStatus, message} given an HTTP status code\n \n Throws: Error if the HTTP status code is not supported (i.e. the 100 codes or non HTTP status code numbers)\n \n @param httpStatus - The HTTP status code to get the communication status for\n * @returns The communication status for the given HTTP status code\n */\nexport const getCommunicationStatusDetails = (httpStatus?: number): CommunicationStatusDetails => {\n if (!httpStatus) return { status: networkFailure, message: \"network failure\" }\n\n let status: CommunicationStatus \| undefined\n\n switch (Math.floor(httpStatus / 100)) {\n case 2: status = success; break\n case 3: status = missing; break\n case 4:\n switch (httpStatus) {\n case 401:\n case 403:\n case 407:\n case 451: status = clientFailureNotAuthorized; break\n case 404: status = missing; break\n default: status = clientFailure\n }\n break\n case 5:\n switch (httpStatus) {\n case 502:\n case 503:\n case 504: status = networkFailure; break\n case 511: status = clientFailureNotAuthorized; break\n case 501: status = missing; break // 501 Not Implemented - i.e. it \"does not exist\" currently - i.e. missing\n case 505: // HTTP Version Not Supported - client should change the request\n case 530: status = clientFailure; break\n default: status = serverFailure; break\n }\n break\n }\n\n if (!status) throw new Error(`httpStatus ${httpStatus} is not a supported CommunicationStatus.`)\n\n return {\n status,\n httpStatus,\n message: `${status} (${httpStatus})`\n }\n}\n\nexport const getCommunicationStatus = (httpStatus?: number): CommunicationStatus =>\n getCommunicationStatusDetails(httpStatus).status\n\nexport const getHttpStatus = (status: CommunicationStatus): number => {\n const httpStatus = communicationStatuses[status]?.httpStatus\n if (!httpStatus) throw new Error(`There is no valid HttpStatus for ${status}.`)\n return httpStatus\n}"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACWA,IAAM,wBAA+C;AAAA,EACnD,SAAS,EAAE,YAAY,IAAI;AAAA,EAC3B,SAAS,EAAE,YAAY,KAAK,SAAS,KAAK;AAAA,EAC1C,eAAe,EAAE,YAAY,KAAK,eAAe,MAAM,SAAS,KAAK;AAAA,EACrE,4BAA4B,EAAE,YAAY,KAAK,eAAe,MAAM,SAAS,KAAK;AAAA,EAClF,eAAe,EAAE,YAAY,KAAK,SAAS,MAAM,eAAe,KAAK;AAAA,EACrE,gBAAgB,EAAE,SAAS,KAAK;AAAA,EAChC,SAAS,EAAE,SAAS,KAAK;AAAA,EACzB,SAAS,CAAC;AAAA,EACV,SAAS,EAAE,YAAY,KAAK,SAAS,KAAK;AAAA,EAC1C,gBAAgB,EAAE,SAAS,KAAK;AAClC;AAMO,IAAM,cAAc;AAapB,IAAM,UAA+B;AAerC,IAAM,UAA+B;AAsBrC,IAAM,gBAAqC;AAmB3C,IAAM,6BAAkD;AAsBxD,IAAM,gBAAqC;AAgB3C,IAAM,iBAAsC;AAc5C,IAAM,UAA+B;AAcrC,IAAM,UAA+B;AAoBrC,IAAM,UAA+B;AAarC,IAAM,iBAAsC;AAI5C,IAAM,YAAY,CAAC,WAAgC,WAAW;AAc9D,IAAM,YAAY,CAAC,WAAgC,CAAC,CAAC,sBAAsB,MAAM,GAAG;AAoBpF,IAAM,kBAAkB,CAAC,WAAgC,CAAC,CAAC,sBAAsB,MAAM,GAAG;AAqB1F,IAAM,kBAAkB,CAAC,WAAgC,CAAC,CAAC,sBAAsB,MAAM,GAAG;AAc1F,IAAM,mBAAmB,CAAC,WAAgC,WAAW;AAGrE,IAAM,qBAAqB,CAAC,WAAgC,UAAU,MAAM,KAAK,CAAC,gBAAgB,MAAM;AAoBxG,IAAM,+BAA+B,CAAC,WAAgC,WAAW;AAYjF,IAAM,YAAY,CAAC,WAAgC,WAAW;AAgB9D,IAAM,YAAY,CAAC,WAAgC,WAAW;AAa9D,IAAM,YAAY,CAAC,WAAgC,WAAW;AAe9D,IAAM,YAAY,CAAC,WAAgC,WAAW;AAgB9D,IAAM,qBAAqB,CAAC,WAAgC,iBAAiB,MAAM,KAAK,UAAU,MAAM,KAAK,UAAU,MAAM;AAK7H,IAAM,gBAAgB,CAAC,WAAmB,YAAY,KAAK,MAAM;AAgBjE,IAAM,gCAAgC,CAAC,eAAoD;AAChG,MAAI,CAAC,WAAY,QAAO,EAAE,QAAQ,gBAAgB,SAAS,kBAAkB;AAE7E,MAAI;AAEJ,UAAQ,KAAK,MAAM,aAAa,GAAG,GAAG;AAAA,IACpC,KAAK;AAAG,eAAS;AAAS;AAAA,IAC1B,KAAK;AAAG,eAAS;AAAS;AAAA,IAC1B,KAAK;AACH,cAAQ,YAAY;AAAA,QAClB,KAAK;AAAA,QACL,KAAK;AAAA,QACL,KAAK;AAAA,QACL,KAAK;AAAK,mBAAS;AAA4B;AAAA,QAC/C,KAAK;AAAK,mBAAS;AAAS;AAAA,QAC5B;AAAS,mBAAS;AAAA,MACpB;AACA;AAAA,IACF,KAAK;AACH,cAAQ,YAAY;AAAA,QAClB,KAAK;AAAA,QACL,KAAK;AAAA,QACL,KAAK;AAAK,mBAAS;AAAgB;AAAA,QACnC,KAAK;AAAK,mBAAS;AAA4B;AAAA,QAC/C,KAAK;AAAK,mBAAS;AAAS;AAAA;AAAA,QAC5B,KAAK;AAAA;AAAA,QACL,KAAK;AAAK,mBAAS;AAAe;AAAA,QAClC;AAAS,mBAAS;AAAe;AAAA,MACnC;AACA;AAAA,EACJ;AAEA,MAAI,CAAC,OAAQ,OAAM,IAAI,MAAM,cAAc,UAAU,0CAA0C;AAE/F,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,SAAS,GAAG,MAAM,KAAK,UAAU;AAAA,EACnC;AACF;AAEO,IAAM,yBAAyB,CAAC,eACrC,8BAA8B,UAAU,EAAE;AAErC,IAAM,gBAAgB,CAAC,WAAwC;AACpE,QAAM,aAAa,sBAAsB,MAAM,GAAG;AAClD,MAAI,CAAC,WAAY,OAAM,IAAI,MAAM,oCAAoC,MAAM,GAAG;AAC9E,SAAO;AACT;","names":[]}
1	+ {"version":3,"sources":["../src/index.ts","../src/CommunicationStatusConsts.ts","../src/CommunicationStatusTypes.ts","../src/CommunicationStatusTests.ts","../src/CommunicationStatus.ts"],"sourcesContent":["export * from \"./CommunicationStatus\";\nexport * from \"./CommunicationStatusConsts\";\nexport * from \"./CommunicationStatusTests\";\nexport * from \"./CommunicationStatusTypes\";\n","// Export status constants\nimport type { CommunicationStatus } from './CommunicationStatusTypes'\n\n/*\n HTTP 2xx responses\n \n Client Can Automatically:\n * - Process the successful response\n * - Update UI to reflect success\n \n Client Developer Can:\n * - Handle the successful response data\n /\nexport const success: CommunicationStatus = \"success\"\n\n/\n Resource not found\n \n HTTP Status Codes Covered:\n * - 404: Not Found\n \n Client Can Automatically:\n * - notify the user that the resource was not found\n * - prompt the user to request a different resource\n \n Client Developer Can:\n * - fix the bad resource paths\n /\nexport const missing: CommunicationStatus = \"missing\"\n\n/\n Client-side errors; i.e. the client needs to change the request somehow to succeed\n \n HTTP Status Codes Covered:\n * - 400: Bad Request\n * - 401: Unauthorized\n * - 403: Forbidden\n * - 407: Proxy Authentication Required\n * - 409: Conflict\n * - 422: Unprocessable Entity\n \n Client Can Automatically:\n * - Notify the user that the client is experiencing issues\n * - Prompt user to correct invalid input\n \n Client Developer Can:\n * - use isClientFailureNotAuthorized to check for 401/403/407/451\n * - fix the request to avoid the 4xx error\n * - validate input before sending requests\n /\nexport const clientFailure: CommunicationStatus = \"clientFailure\"\n\n/\n Unauthorized requests; i.e. client needs to change the credentials (or the grants for the current credentials) to succeed\n \n HTTP Status Codes Covered:\n * - 401: Unauthorized\n * - 403: Forbidden\n * - 407: Proxy Authentication Required\n * - 451: Unavailable For Legal Reasons\n \n Client Can Automatically:\n * - refresh the request token\n * - prompt the user to re-login\n * - ask the user to contact the administrator for access\n \n Client and Server Developer Can:\n * - fix authorization / authentication bugs\n /\nexport const clientFailureNotAuthorized: CommunicationStatus = \"clientFailureNotAuthorized\"\n\n/\n Server-side errors; i.e. internal server errors\n \n HTTP Status Codes Covered:\n * - 500: Internal Server Error\n * - 502: Bad Gateway\n * - 503: Service Unavailable\n * - 504: Gateway Timeout\n \n Client Can Automatically:\n * - Ask the user to try again later\n * - Notify the user that the server is experiencing issues\n * - Implement automatic retry with backoff\n \n Client Developer: (probably) can't fix\n \n Server Developer Can:\n * - fix the server to avoid the 5xx error\n * - fix server infrastructure to avoid the 5xx error\n /\nexport const serverFailure: CommunicationStatus = \"serverFailure\"\n\n/\n Request fails due to network connectivity issues\n \n HTTP Status Codes Covered: NONE (server was not reachable)\n \n Client Can Automatically:\n * - Prompt the user to fix the network connection\n * - Retry the request when network is available\n * - Monitor network status for recovery\n \n Client Developer Can:\n * - fix bad network constants (like address, ports, etc.)\n * - implement offline-first capabilities\n /\nexport const networkFailure: CommunicationStatus = \"networkFailure\"\n\n/\n Request was cancelled by client\n \n Client Can Automatically:\n * - notify the user that the request was cancelled\n * - prompt the user to try again\n * - cleanup any pending state\n \n Client Developer Can:\n * - fix the client to not abort the request unnecessarily\n * - implement proper cleanup on abort\n /\nexport const aborted: CommunicationStatus = \"aborted\"\n\n/\n Request is in progress\n \n Client Can Automatically:\n * - notify the user that the request is in progress\n * - show the user progress (if available)\n * - allow the user to cancel the request\n \n Client Developer Can:\n * - if \"pending\" was not expected, maybe the client needs to `wait` for the request to complete?\n * - implement proper loading states\n /\nexport const pending: CommunicationStatus = \"pending\"\n\n/\n Any error response (HTTP 4xx/5xx) or network/abort failures\n \n HTTP Status Codes Covered:\n * - 4xx: Client-side errors (except 404)\n * - 5xx: Server-side errors\n * - Network failures\n * - Abort failures\n \n Client Can Automatically:\n * - Show appropriate error message to user\n * - Implement generic error handling\n * - Log errors for debugging\n \n Client Developer Can:\n * - Use more specific is* functions for targeted error handling\n * - Implement proper error recovery strategies\n /\nexport const failure: CommunicationStatus = \"failure\"\n\n/\n Request timed out\n \n Client Can Automatically:\n * - notify the user that the request timed out\n * - try again (automatically or via user action)\n \n Client Developer Can:\n * - fix the client to not timeoutFailure the request\n * - implement proper timeoutFailure handling\n /\nexport const timeoutFailure: CommunicationStatus = \"timeoutFailure\"\n","interface CommunicationStatusInfo {\n httpStatus?: number\n failure?: boolean\n clientFailure?: boolean\n serverFailure?: boolean\n}\n\nexport const communicationStatuses: Record<string, CommunicationStatusInfo> = {\n success: { httpStatus: 200 },\n missing: { httpStatus: 404, failure: true },\n clientFailure: { httpStatus: 400, clientFailure: true, failure: true },\n clientFailureNotAuthorized: { httpStatus: 403, clientFailure: true, failure: true },\n serverFailure: { httpStatus: 500, failure: true, serverFailure: true },\n networkFailure: { failure: true },\n aborted: { failure: true },\n pending: {},\n failure: { httpStatus: 500, failure: true },\n timeoutFailure: { failure: true }\n}\n\nexport type CommunicationStatuses = typeof communicationStatuses\nexport type CommunicationStatus = keyof CommunicationStatuses\n\n/\n RegEx returns true for all valid communication statuses\n /\nexport const statusRegex = new RegExp(`^(${Object.keys(communicationStatuses).join('\|')})$`)\n\nexport interface CommunicationStatusDetails {\n status: CommunicationStatus\n httpStatus?: number\n message: string\n}\n","import { communicationStatuses, CommunicationStatus, statusRegex } from './CommunicationStatusTypes'\nimport { success, missing, clientFailure, clientFailureNotAuthorized, serverFailure, networkFailure, aborted, pending, timeoutFailure } from './CommunicationStatusConsts'\n\n// Core status check functions\n/* Returns true for HTTP 2xx responses /\nexport const isSuccess = (status: CommunicationStatus) => status === success\n\n/\n Returns true for any error response (HTTP 4xx/5xx) or network/abort failures\n \n HTTP Status Codes Covered:\n * - 4xx: Client-side errors (except 404)\n * - 5xx: Server-side errors\n * - Network failures\n * - Abort failures\n \n Client Can:\n * - Use a different is* function for more specific checks\n /\nexport const isFailure = (status: CommunicationStatus) => !!communicationStatuses[status]?.failure\n\n/\n Returns true for client-side errors\n \n HTTP Status Codes Covered:\n * - 400: Bad Request\n * - 401: Unauthorized\n * - 403: Forbidden\n * - 407: Proxy Authentication Required\n * - 409: Conflict\n * - 422: Unprocessable Entity\n \n Client Can Automatically:\n * - Notify the user that the client is experiencing issues\n \n Client Developer Can:\n * - use isClientFailureNotAuthorized to check for 401/403/407/451\n * - fix the request to avoid the 4xx error\n/\nexport const isClientFailure = (status: CommunicationStatus) => !!communicationStatuses[status]?.clientFailure\n\n/\n Returns true for server-side errors\n \n HTTP Status Codes Covered:\n * - 500: Internal Server Error\n * - 502: Bad Gateway\n * - 503: Service Unavailable\n * - 504: Gateway Timeout\n \n Client Can Automatically:\n * - Ask the user to try again later\n * - Notify the user that the server is experiencing issues\n \n Client Developer: (probably) can't fix\n \n Server Developer Can:\n * - fix the server to avoid the 5xx error\n * - fix server infrastructure to avoid the 5xx error (e.g. Bad Gateway, Service Unavailable, Gateway Timeout)\n/\nexport const isServerFailure = (status: CommunicationStatus) => !!communicationStatuses[status]?.serverFailure\n\n/\n Returns true when request fails due to network connectivity issues\n \n HTTP Status Codes Covered: NONE (server was not reachable)\n \n Client Can Automatically:\n * - Prompt the user to fix the network connection\n * - Retry the request\n \n Client Developer Can:\n * - fix bad network constants (like address, ports, etc.)\n/\nexport const isNetworkFailure = (status: CommunicationStatus) => status === networkFailure\n\n/* Returns true for server errors, network failures and aborted requests; i.e. the client did nothing wrong (as far as we can tell); client can ask the user to do something OR retry the request /\nexport const isNonClientFailure = (status: CommunicationStatus) => isFailure(status) && !isClientFailure(status)\n\n/\n Returns true for unauthorized requests (not authenticated or not authorized)\n \n HTTP Status Codes Covered:\n * - 401: Unauthorized\n * - 403: Forbidden\n * - 407: Proxy Authentication Required\n * - 451: Unavailable For Legal Reasons\n * - 511: Network Authentication Required\n \n Client Can Automatically:\n * - refresh the request token\n * - prompt the user to re-login\n * - ask the user to contact the administrator for access\n \n Client and Server Developer Can:\n * - fix authorization / authentication bugs\n /\nexport const isClientFailureNotAuthorized = (status: CommunicationStatus) => status === clientFailureNotAuthorized\n\n/\n Returns true when request was cancelled by client\n \n Client Can Automatically:\n * - notify the user that the request was cancelled\n * - prompt the user to try again\n \n Client Developer Can:\n * - fix the client to not abort the request\n /\nexport const isAborted = (status: CommunicationStatus) => status === aborted\n\n/\n Returns true when resource not found / not available\n \n HTTP Status Codes Covered:\n * - 404: Not Found\n * - 501: Not Implemented\n \n Client Can Automatically:\n * - notify the user that the resource was not found\n * - prompt the user to request a different resource\n \n Client Developer Can:\n * - fix the bad resource paths\n /\nexport const isMissing = (status: CommunicationStatus) => status === missing\n\n/\n Returns true while request is in progress\n \n Client Can Automatically:\n * - notify the user that the request is in progress\n * - show the user progress (if available)\n * - allow the user to cancel the request (trigging an \"aborted\" communication status)\n \n Client Developer Can:\n * - if \"pending\" was not expected, maybe the client needs to `wait` for the request to complete?\n /\nexport const isPending = (status: CommunicationStatus) => status === pending\n\n/\n Returns true if the request timed out\n \n Client Can Automatically:\n * - notify the user that the request timed out\n * - try again (automatically or via user action)\n \n Client Developer Can:\n * - extend the timeoutFailure duration\n \n Server Developer Can:\n * - improve server performance and reliability\n /\nexport const isTimeout = (status: CommunicationStatus) => status === timeoutFailure\n\n/\n Returns true if client can safely retry the request\n \n A a clearly-retryable failure:\n \n - network failure\n * - timeoutFailure\n * - aborted\n \n Note: some serverFailures will succeed on retry, but HTTP doesn't return clear indications which ones. To be safe, the client should not retry serverFailures indiscriminately.\n \n Client and Server Devs can\n * - investigate network, client and server performance and reliability issues\n /\nexport const isRetryableFailure = (status: CommunicationStatus) => isNetworkFailure(status) \|\| isTimeout(status) \|\| isAborted(status)\n\n/\n Returns true if the status is a valid communication status\n /\nexport const isStatusValid = (status: string) => statusRegex.test(status);\n","import { clientFailure, clientFailureNotAuthorized, missing, networkFailure, serverFailure, success } from './CommunicationStatusConsts';\nimport { isStatusValid } from './CommunicationStatusTests';\nimport { CommunicationStatus, CommunicationStatusDetails, communicationStatuses } from './CommunicationStatusTypes';\n\nexport const getCommunicationStatusFromHttpStatusOrUndefined = (httpStatus: number): CommunicationStatus \| undefined => {\n switch (Math.floor(httpStatus / 100)) {\n case 2: return success;\n case 3: return missing;\n case 4:\n switch (httpStatus) {\n case 401:\n case 403:\n case 407:\n case 451: return clientFailureNotAuthorized;\n case 404: return missing;\n default: return clientFailure;\n }\n case 5:\n switch (httpStatus) {\n case 502:\n case 503:\n case 504: return networkFailure;\n case 511: return clientFailureNotAuthorized;\n case 501: return missing; // 501 Not Implemented - i.e. it \"does not exist\" currently - i.e. missing\n case 505: // HTTP Version Not Supported - client should change the request\n case 530: return clientFailure;\n default: return serverFailure;\n }\n }\n return undefined;\n};\n\nexport const getCommunicationStatusFromHttpStatus = (httpStatus: number): CommunicationStatus => {\n const status = getCommunicationStatusFromHttpStatusOrUndefined(httpStatus);\n if (!status) {\n throw new Error(`httpStatus ${httpStatus} is not a supported CommunicationStatus.`);\n }\n return status;\n};\n\n/\n Returns CommunicationStatusDetails {status, httpStatus, message} given an HTTP status code\n \n Throws: Error if the HTTP status code is not supported (i.e. the 100 codes or non HTTP status code numbers)\n \n @param httpStatus - The HTTP status code to get the communication status for\n * @returns The communication status for the given HTTP status code\n */\nexport const getCommunicationStatusDetails = (httpStatus?: number): CommunicationStatusDetails => {\n if (!httpStatus) return { status: networkFailure, message: \"network failure\" };\n\n const status = getCommunicationStatusFromHttpStatus(httpStatus);\n\n return {\n status,\n httpStatus,\n message: `${status} (${httpStatus})`\n };\n};\n\nexport const getCommunicationStatusOrUndefined = <T extends number \| CommunicationStatus \| null \| undefined>(\n status: T\n): T extends null \| undefined ? undefined : (CommunicationStatus \| undefined) => {\n if (status == null) return undefined as any;\n if (typeof status === 'string') {\n if (!isStatusValid(status)) {\n return undefined;\n }\n return status as any;\n }\n if (typeof status === 'number') {\n return getCommunicationStatusFromHttpStatusOrUndefined(status) as any;\n }\n return undefined;\n};\n\nexport const getCommunicationStatus = <T extends number \| CommunicationStatus \| null \| undefined>(\n status: T\n): T extends null \| undefined ? undefined : CommunicationStatus => {\n if (status == null) return undefined as any;\n if (typeof status === 'number') {\n return getCommunicationStatusFromHttpStatus(status) as any;\n }\n const communicationStatus: CommunicationStatus \| undefined = getCommunicationStatusOrUndefined(status);\n if (!communicationStatus) {\n throw new Error(`${status} is not a valid CommunicationStatus.`);\n }\n return communicationStatus as any;\n};\n\nexport const getHttpStatus = (status: CommunicationStatus): number => {\n const httpStatus = communicationStatuses[status]?.httpStatus;\n if (!httpStatus) throw new Error(`There is no valid HttpStatus for ${status}.`);\n return httpStatus;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACaO,IAAM,UAA+B;AAerC,IAAM,UAA+B;AAsBrC,IAAM,gBAAqC;AAmB3C,IAAM,6BAAkD;AAsBxD,IAAM,gBAAqC;AAgB3C,IAAM,iBAAsC;AAc5C,IAAM,UAA+B;AAcrC,IAAM,UAA+B;AAoBrC,IAAM,UAA+B;AAarC,IAAM,iBAAsC;;;ACjK5C,IAAM,wBAAiE;AAAA,EAC5E,SAAS,EAAE,YAAY,IAAI;AAAA,EAC3B,SAAS,EAAE,YAAY,KAAK,SAAS,KAAK;AAAA,EAC1C,eAAe,EAAE,YAAY,KAAK,eAAe,MAAM,SAAS,KAAK;AAAA,EACrE,4BAA4B,EAAE,YAAY,KAAK,eAAe,MAAM,SAAS,KAAK;AAAA,EAClF,eAAe,EAAE,YAAY,KAAK,SAAS,MAAM,eAAe,KAAK;AAAA,EACrE,gBAAgB,EAAE,SAAS,KAAK;AAAA,EAChC,SAAS,EAAE,SAAS,KAAK;AAAA,EACzB,SAAS,CAAC;AAAA,EACV,SAAS,EAAE,YAAY,KAAK,SAAS,KAAK;AAAA,EAC1C,gBAAgB,EAAE,SAAS,KAAK;AAClC;AAQO,IAAM,cAAc,IAAI,OAAO,KAAK,OAAO,KAAK,qBAAqB,EAAE,KAAK,GAAG,CAAC,IAAI;;;ACrBpF,IAAM,YAAY,CAAC,WAAgC,WAAW;AAc9D,IAAM,YAAY,CAAC,WAAgC,CAAC,CAAC,sBAAsB,MAAM,GAAG;AAoBpF,IAAM,kBAAkB,CAAC,WAAgC,CAAC,CAAC,sBAAsB,MAAM,GAAG;AAqB1F,IAAM,kBAAkB,CAAC,WAAgC,CAAC,CAAC,sBAAsB,MAAM,GAAG;AAc1F,IAAM,mBAAmB,CAAC,WAAgC,WAAW;AAGrE,IAAM,qBAAqB,CAAC,WAAgC,UAAU,MAAM,KAAK,CAAC,gBAAgB,MAAM;AAoBxG,IAAM,+BAA+B,CAAC,WAAgC,WAAW;AAYjF,IAAM,YAAY,CAAC,WAAgC,WAAW;AAgB9D,IAAM,YAAY,CAAC,WAAgC,WAAW;AAa9D,IAAM,YAAY,CAAC,WAAgC,WAAW;AAe9D,IAAM,YAAY,CAAC,WAAgC,WAAW;AAgB9D,IAAM,qBAAqB,CAAC,WAAgC,iBAAiB,MAAM,KAAK,UAAU,MAAM,KAAK,UAAU,MAAM;AAK7H,IAAM,gBAAgB,CAAC,WAAmB,YAAY,KAAK,MAAM;;;AC1KjE,IAAM,kDAAkD,CAAC,eAAwD;AACtH,UAAQ,KAAK,MAAM,aAAa,GAAG,GAAG;AAAA,IACpC,KAAK;AAAG,aAAO;AAAA,IACf,KAAK;AAAG,aAAO;AAAA,IACf,KAAK;AACH,cAAQ,YAAY;AAAA,QAClB,KAAK;AAAA,QACL,KAAK;AAAA,QACL,KAAK;AAAA,QACL,KAAK;AAAK,iBAAO;AAAA,QACjB,KAAK;AAAK,iBAAO;AAAA,QACjB;AAAS,iBAAO;AAAA,MAClB;AAAA,IACF,KAAK;AACH,cAAQ,YAAY;AAAA,QAClB,KAAK;AAAA,QACL,KAAK;AAAA,QACL,KAAK;AAAK,iBAAO;AAAA,QACjB,KAAK;AAAK,iBAAO;AAAA,QACjB,KAAK;AAAK,iBAAO;AAAA;AAAA,QACjB,KAAK;AAAA;AAAA,QACL,KAAK;AAAK,iBAAO;AAAA,QACjB;AAAS,iBAAO;AAAA,MAClB;AAAA,EACJ;AACA,SAAO;AACT;AAEO,IAAM,uCAAuC,CAAC,eAA4C;AAC/F,QAAM,SAAS,gDAAgD,UAAU;AACzE,MAAI,CAAC,QAAQ;AACX,UAAM,IAAI,MAAM,cAAc,UAAU,0CAA0C;AAAA,EACpF;AACA,SAAO;AACT;AAUO,IAAM,gCAAgC,CAAC,eAAoD;AAChG,MAAI,CAAC,WAAY,QAAO,EAAE,QAAQ,gBAAgB,SAAS,kBAAkB;AAE7E,QAAM,SAAS,qCAAqC,UAAU;AAE9D,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,SAAS,GAAG,MAAM,KAAK,UAAU;AAAA,EACnC;AACF;AAEO,IAAM,oCAAoC,CAC/C,WAC+E;AAC/E,MAAI,UAAU,KAAM,QAAO;AAC3B,MAAI,OAAO,WAAW,UAAU;AAC9B,QAAI,CAAC,cAAc,MAAM,GAAG;AAC1B,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AACA,MAAI,OAAO,WAAW,UAAU;AAC9B,WAAO,gDAAgD,MAAM;AAAA,EAC/D;AACA,SAAO;AACT;AAEO,IAAM,yBAAyB,CACpC,WACiE;AACjE,MAAI,UAAU,KAAM,QAAO;AAC3B,MAAI,OAAO,WAAW,UAAU;AAC9B,WAAO,qCAAqC,MAAM;AAAA,EACpD;AACA,QAAM,sBAAuD,kCAAkC,MAAM;AACrG,MAAI,CAAC,qBAAqB;AACxB,UAAM,IAAI,MAAM,GAAG,MAAM,sCAAsC;AAAA,EACjE;AACA,SAAO;AACT;AAEO,IAAM,gBAAgB,CAAC,WAAwC;AACpE,QAAM,aAAa,sBAAsB,MAAM,GAAG;AAClD,MAAI,CAAC,WAAY,OAAM,IAAI,MAAM,oCAAoC,MAAM,GAAG;AAC9E,SAAO;AACT;","names":[]}

package/dist/index.d.cts CHANGED Viewed

@@ -1,8 +1,37 @@
-type CommunicationStatus = "success" | "missing" | "clientFailure" | "clientFailureNotAuthorized" | "serverFailure" | "networkFailure" | "aborted" | "pending" | "failure" | "timeoutFailure";
+interface CommunicationStatusInfo {
+    httpStatus?: number;
+    failure?: boolean;
+    clientFailure?: boolean;
+    serverFailure?: boolean;
+}
+declare const communicationStatuses: Record<string, CommunicationStatusInfo>;
+type CommunicationStatuses = typeof communicationStatuses;
+type CommunicationStatus = keyof CommunicationStatuses;
 /**
  * RegEx returns true for all valid communication statuses
  */
 declare const statusRegex: RegExp;
+interface CommunicationStatusDetails {
+    status: CommunicationStatus;
+    httpStatus?: number;
+    message: string;
+}
+declare const getCommunicationStatusFromHttpStatusOrUndefined: (httpStatus: number) => CommunicationStatus | undefined;
+declare const getCommunicationStatusFromHttpStatus: (httpStatus: number) => CommunicationStatus;
+/**
+ * Returns CommunicationStatusDetails {status, httpStatus, message} given an HTTP status code
+ *
+ * Throws: Error if the HTTP status code is not supported (i.e. the 100 codes or non HTTP status code numbers)
+ *
+ * @param httpStatus - The HTTP status code to get the communication status for
+ * @returns The communication status for the given HTTP status code
+ */
+declare const getCommunicationStatusDetails: (httpStatus?: number) => CommunicationStatusDetails;
+declare const getCommunicationStatusOrUndefined: <T extends number | CommunicationStatus | null | undefined>(status: T) => T extends null | undefined ? undefined : (CommunicationStatus | undefined);
+declare const getCommunicationStatus: <T extends number | CommunicationStatus | null | undefined>(status: T) => T extends null | undefined ? undefined : CommunicationStatus;
+declare const getHttpStatus: (status: CommunicationStatus) => number;
 /**
  * HTTP 2xx responses
  *
@@ -160,8 +189,9 @@ declare const failure: CommunicationStatus;
  * - implement proper timeoutFailure handling
  */
 declare const timeoutFailure: CommunicationStatus;
 /** Returns true for HTTP 2xx responses */
-declare const isSuccess: (status: CommunicationStatus) => status is "success";
+declare const isSuccess: (status: CommunicationStatus) => boolean;
 /**
  * Returns true for any error response (HTTP 4xx/5xx) or network/abort failures
  *
@@ -226,7 +256,7 @@ declare const isServerFailure: (status: CommunicationStatus) => boolean;
  * Client Developer Can:
  * - fix bad network constants (like address, ports, etc.)
 */
-declare const isNetworkFailure: (status: CommunicationStatus) => status is "networkFailure";
+declare const isNetworkFailure: (status: CommunicationStatus) => boolean;
 /** Returns true for server errors, network failures and aborted requests; i.e. the client did nothing wrong (as far as we can tell); client can ask the user to do something OR retry the request */
 declare const isNonClientFailure: (status: CommunicationStatus) => boolean;
 /**
@@ -247,7 +277,7 @@ declare const isNonClientFailure: (status: CommunicationStatus) => boolean;
  * Client and Server Developer Can:
  * - fix authorization / authentication bugs
  */
-declare const isClientFailureNotAuthorized: (status: CommunicationStatus) => status is "clientFailureNotAuthorized";
+declare const isClientFailureNotAuthorized: (status: CommunicationStatus) => boolean;
 /**
  * Returns true when request was cancelled by client
  *
@@ -258,7 +288,7 @@ declare const isClientFailureNotAuthorized: (status: CommunicationStatus) => sta
  * Client Developer Can:
  * - fix the client to not abort the request
  */
-declare const isAborted: (status: CommunicationStatus) => status is "aborted";
+declare const isAborted: (status: CommunicationStatus) => boolean;
 /**
  * Returns true when resource not found / not available
  *
@@ -273,7 +303,7 @@ declare const isAborted: (status: CommunicationStatus) => status is "aborted";
  * Client Developer Can:
  * - fix the bad resource paths
  */
-declare const isMissing: (status: CommunicationStatus) => status is "missing";
+declare const isMissing: (status: CommunicationStatus) => boolean;
 /**
  * Returns true while request is in progress
  *
@@ -285,7 +315,7 @@ declare const isMissing: (status: CommunicationStatus) => status is "missing";
  * Client Developer Can:
  * - if "pending" was not expected, maybe the client needs to `wait` for the request to complete?
  */
-declare const isPending: (status: CommunicationStatus) => status is "pending";
+declare const isPending: (status: CommunicationStatus) => boolean;
 /**
  * Returns true if the request timed out
  *
@@ -299,7 +329,7 @@ declare const isPending: (status: CommunicationStatus) => status is "pending";
  * Server Developer Can:
  * - improve server performance and reliability
  */
-declare const isTimeout: (status: CommunicationStatus) => status is "timeoutFailure";
+declare const isTimeout: (status: CommunicationStatus) => boolean;
 /**
  * Returns true if client can safely retry the request
  *
@@ -314,26 +344,10 @@ declare const isTimeout: (status: CommunicationStatus) => status is "timeoutFail
  * Client and Server Devs can
  * - investigate network, client and server performance and reliability issues
  */
-declare const isRetryableFailure: (status: CommunicationStatus) => status is "networkFailure" | "aborted" | "timeoutFailure";
+declare const isRetryableFailure: (status: CommunicationStatus) => boolean;
 /**
  * Returns true if the status is a valid communication status
  */
 declare const isStatusValid: (status: string) => boolean;
-interface CommunicationStatusDetails {
-    status: CommunicationStatus;
-    httpStatus?: number;
-    message: string;
-}
-/**
- * Returns CommunicationStatusDetails {status, httpStatus, message} given an HTTP status code
- *
- * Throws: Error if the HTTP status code is not supported (i.e. the 100 codes or non HTTP status code numbers)
- *
- * @param httpStatus - The HTTP status code to get the communication status for
- * @returns The communication status for the given HTTP status code
- */
-declare const getCommunicationStatusDetails: (httpStatus?: number) => CommunicationStatusDetails;
-declare const getCommunicationStatus: (httpStatus?: number) => CommunicationStatus;
-declare const getHttpStatus: (status: CommunicationStatus) => number;
-export { type CommunicationStatus, aborted, clientFailure, clientFailureNotAuthorized, failure, getCommunicationStatus, getCommunicationStatusDetails, getHttpStatus, isAborted, isClientFailure, isClientFailureNotAuthorized, isFailure, isMissing, isNetworkFailure, isNonClientFailure, isPending, isRetryableFailure, isServerFailure, isStatusValid, isSuccess, isTimeout, missing, networkFailure, pending, serverFailure, statusRegex, success, timeoutFailure };
+export { type CommunicationStatus, type CommunicationStatusDetails, type CommunicationStatuses, aborted, clientFailure, clientFailureNotAuthorized, communicationStatuses, failure, getCommunicationStatus, getCommunicationStatusDetails, getCommunicationStatusFromHttpStatus, getCommunicationStatusFromHttpStatusOrUndefined, getCommunicationStatusOrUndefined, getHttpStatus, isAborted, isClientFailure, isClientFailureNotAuthorized, isFailure, isMissing, isNetworkFailure, isNonClientFailure, isPending, isRetryableFailure, isServerFailure, isStatusValid, isSuccess, isTimeout, missing, networkFailure, pending, serverFailure, statusRegex, success, timeoutFailure };

package/dist/index.d.ts CHANGED Viewed

@@ -1,8 +1,37 @@
-type CommunicationStatus = "success" | "missing" | "clientFailure" | "clientFailureNotAuthorized" | "serverFailure" | "networkFailure" | "aborted" | "pending" | "failure" | "timeoutFailure";
+interface CommunicationStatusInfo {
+    httpStatus?: number;
+    failure?: boolean;
+    clientFailure?: boolean;
+    serverFailure?: boolean;
+}
+declare const communicationStatuses: Record<string, CommunicationStatusInfo>;
+type CommunicationStatuses = typeof communicationStatuses;
+type CommunicationStatus = keyof CommunicationStatuses;
 /**
  * RegEx returns true for all valid communication statuses
  */
 declare const statusRegex: RegExp;
+interface CommunicationStatusDetails {
+    status: CommunicationStatus;
+    httpStatus?: number;
+    message: string;
+}
+declare const getCommunicationStatusFromHttpStatusOrUndefined: (httpStatus: number) => CommunicationStatus | undefined;
+declare const getCommunicationStatusFromHttpStatus: (httpStatus: number) => CommunicationStatus;
+/**
+ * Returns CommunicationStatusDetails {status, httpStatus, message} given an HTTP status code
+ *
+ * Throws: Error if the HTTP status code is not supported (i.e. the 100 codes or non HTTP status code numbers)
+ *
+ * @param httpStatus - The HTTP status code to get the communication status for
+ * @returns The communication status for the given HTTP status code
+ */
+declare const getCommunicationStatusDetails: (httpStatus?: number) => CommunicationStatusDetails;
+declare const getCommunicationStatusOrUndefined: <T extends number | CommunicationStatus | null | undefined>(status: T) => T extends null | undefined ? undefined : (CommunicationStatus | undefined);
+declare const getCommunicationStatus: <T extends number | CommunicationStatus | null | undefined>(status: T) => T extends null | undefined ? undefined : CommunicationStatus;
+declare const getHttpStatus: (status: CommunicationStatus) => number;
 /**
  * HTTP 2xx responses
  *
@@ -160,8 +189,9 @@ declare const failure: CommunicationStatus;
  * - implement proper timeoutFailure handling
  */
 declare const timeoutFailure: CommunicationStatus;
 /** Returns true for HTTP 2xx responses */
-declare const isSuccess: (status: CommunicationStatus) => status is "success";
+declare const isSuccess: (status: CommunicationStatus) => boolean;
 /**
  * Returns true for any error response (HTTP 4xx/5xx) or network/abort failures
  *
@@ -226,7 +256,7 @@ declare const isServerFailure: (status: CommunicationStatus) => boolean;
  * Client Developer Can:
  * - fix bad network constants (like address, ports, etc.)
 */
-declare const isNetworkFailure: (status: CommunicationStatus) => status is "networkFailure";
+declare const isNetworkFailure: (status: CommunicationStatus) => boolean;
 /** Returns true for server errors, network failures and aborted requests; i.e. the client did nothing wrong (as far as we can tell); client can ask the user to do something OR retry the request */
 declare const isNonClientFailure: (status: CommunicationStatus) => boolean;
 /**
@@ -247,7 +277,7 @@ declare const isNonClientFailure: (status: CommunicationStatus) => boolean;
  * Client and Server Developer Can:
  * - fix authorization / authentication bugs
  */
-declare const isClientFailureNotAuthorized: (status: CommunicationStatus) => status is "clientFailureNotAuthorized";
+declare const isClientFailureNotAuthorized: (status: CommunicationStatus) => boolean;
 /**
  * Returns true when request was cancelled by client
  *
@@ -258,7 +288,7 @@ declare const isClientFailureNotAuthorized: (status: CommunicationStatus) => sta
  * Client Developer Can:
  * - fix the client to not abort the request
  */
-declare const isAborted: (status: CommunicationStatus) => status is "aborted";
+declare const isAborted: (status: CommunicationStatus) => boolean;
 /**
  * Returns true when resource not found / not available
  *
@@ -273,7 +303,7 @@ declare const isAborted: (status: CommunicationStatus) => status is "aborted";
  * Client Developer Can:
  * - fix the bad resource paths
  */
-declare const isMissing: (status: CommunicationStatus) => status is "missing";
+declare const isMissing: (status: CommunicationStatus) => boolean;
 /**
  * Returns true while request is in progress
  *
@@ -285,7 +315,7 @@ declare const isMissing: (status: CommunicationStatus) => status is "missing";
  * Client Developer Can:
  * - if "pending" was not expected, maybe the client needs to `wait` for the request to complete?
  */
-declare const isPending: (status: CommunicationStatus) => status is "pending";
+declare const isPending: (status: CommunicationStatus) => boolean;
 /**
  * Returns true if the request timed out
  *
@@ -299,7 +329,7 @@ declare const isPending: (status: CommunicationStatus) => status is "pending";
  * Server Developer Can:
  * - improve server performance and reliability
  */
-declare const isTimeout: (status: CommunicationStatus) => status is "timeoutFailure";
+declare const isTimeout: (status: CommunicationStatus) => boolean;
 /**
  * Returns true if client can safely retry the request
  *
@@ -314,26 +344,10 @@ declare const isTimeout: (status: CommunicationStatus) => status is "timeoutFail
  * Client and Server Devs can
  * - investigate network, client and server performance and reliability issues
  */
-declare const isRetryableFailure: (status: CommunicationStatus) => status is "networkFailure" | "aborted" | "timeoutFailure";
+declare const isRetryableFailure: (status: CommunicationStatus) => boolean;
 /**
  * Returns true if the status is a valid communication status
  */
 declare const isStatusValid: (status: string) => boolean;
-interface CommunicationStatusDetails {
-    status: CommunicationStatus;
-    httpStatus?: number;
-    message: string;
-}
-/**
- * Returns CommunicationStatusDetails {status, httpStatus, message} given an HTTP status code
- *
- * Throws: Error if the HTTP status code is not supported (i.e. the 100 codes or non HTTP status code numbers)
- *
- * @param httpStatus - The HTTP status code to get the communication status for
- * @returns The communication status for the given HTTP status code
- */
-declare const getCommunicationStatusDetails: (httpStatus?: number) => CommunicationStatusDetails;
-declare const getCommunicationStatus: (httpStatus?: number) => CommunicationStatus;
-declare const getHttpStatus: (status: CommunicationStatus) => number;
-export { type CommunicationStatus, aborted, clientFailure, clientFailureNotAuthorized, failure, getCommunicationStatus, getCommunicationStatusDetails, getHttpStatus, isAborted, isClientFailure, isClientFailureNotAuthorized, isFailure, isMissing, isNetworkFailure, isNonClientFailure, isPending, isRetryableFailure, isServerFailure, isStatusValid, isSuccess, isTimeout, missing, networkFailure, pending, serverFailure, statusRegex, success, timeoutFailure };
+export { type CommunicationStatus, type CommunicationStatusDetails, type CommunicationStatuses, aborted, clientFailure, clientFailureNotAuthorized, communicationStatuses, failure, getCommunicationStatus, getCommunicationStatusDetails, getCommunicationStatusFromHttpStatus, getCommunicationStatusFromHttpStatusOrUndefined, getCommunicationStatusOrUndefined, getHttpStatus, isAborted, isClientFailure, isClientFailureNotAuthorized, isFailure, isMissing, isNetworkFailure, isNonClientFailure, isPending, isRetryableFailure, isServerFailure, isStatusValid, isSuccess, isTimeout, missing, networkFailure, pending, serverFailure, statusRegex, success, timeoutFailure };

package/dist/index.js CHANGED Viewed

@@ -1,4 +1,16 @@
-// src/CommunicationStatus.ts
+// src/CommunicationStatusConsts.ts
+var success = "success";
+var missing = "missing";
+var clientFailure = "clientFailure";
+var clientFailureNotAuthorized = "clientFailureNotAuthorized";
+var serverFailure = "serverFailure";
+var networkFailure = "networkFailure";
+var aborted = "aborted";
+var pending = "pending";
+var failure = "failure";
+var timeoutFailure = "timeoutFailure";
+// src/CommunicationStatusTypes.ts
 var communicationStatuses = {
   success: { httpStatus: 200 },
   missing: { httpStatus: 404, failure: true },
@@ -11,17 +23,9 @@ var communicationStatuses = {
   failure: { httpStatus: 500, failure: true },
   timeoutFailure: { failure: true }
 };
-var statusRegex = /^(success|missing|clientFailure|clientFailureNotAuthorized|serverFailure|networkFailure|aborted|pending|failure|timeoutFailure)$/;
-var success = "success";
-var missing = "missing";
-var clientFailure = "clientFailure";
-var clientFailureNotAuthorized = "clientFailureNotAuthorized";
-var serverFailure = "serverFailure";
-var networkFailure = "networkFailure";
-var aborted = "aborted";
-var pending = "pending";
-var failure = "failure";
-var timeoutFailure = "timeoutFailure";
+var statusRegex = new RegExp(`^(${Object.keys(communicationStatuses).join("|")})$`);
+// src/CommunicationStatusTests.ts
 var isSuccess = (status) => status === success;
 var isFailure = (status) => !!communicationStatuses[status]?.failure;
 var isClientFailure = (status) => !!communicationStatuses[status]?.clientFailure;
@@ -35,64 +39,87 @@ var isPending = (status) => status === pending;
 var isTimeout = (status) => status === timeoutFailure;
 var isRetryableFailure = (status) => isNetworkFailure(status) || isTimeout(status) || isAborted(status);
 var isStatusValid = (status) => statusRegex.test(status);
-var getCommunicationStatusDetails = (httpStatus) => {
-  if (!httpStatus) return { status: networkFailure, message: "network failure" };
-  let status;
+// src/CommunicationStatus.ts
+var getCommunicationStatusFromHttpStatusOrUndefined = (httpStatus) => {
   switch (Math.floor(httpStatus / 100)) {
     case 2:
-      status = success;
-      break;
+      return success;
     case 3:
-      status = missing;
-      break;
+      return missing;
     case 4:
       switch (httpStatus) {
         case 401:
         case 403:
         case 407:
         case 451:
-          status = clientFailureNotAuthorized;
-          break;
+          return clientFailureNotAuthorized;
         case 404:
-          status = missing;
-          break;
+          return missing;
         default:
-          status = clientFailure;
+          return clientFailure;
       }
-      break;
     case 5:
       switch (httpStatus) {
         case 502:
         case 503:
         case 504:
-          status = networkFailure;
-          break;
+          return networkFailure;
         case 511:
-          status = clientFailureNotAuthorized;
-          break;
+          return clientFailureNotAuthorized;
         case 501:
-          status = missing;
-          break;
+          return missing;
         // 501 Not Implemented - i.e. it "does not exist" currently - i.e. missing
         case 505:
         // HTTP Version Not Supported - client should change the request
         case 530:
-          status = clientFailure;
-          break;
+          return clientFailure;
         default:
-          status = serverFailure;
-          break;
+          return serverFailure;
       }
-      break;
   }
-  if (!status) throw new Error(`httpStatus ${httpStatus} is not a supported CommunicationStatus.`);
+  return void 0;
+};
+var getCommunicationStatusFromHttpStatus = (httpStatus) => {
+  const status = getCommunicationStatusFromHttpStatusOrUndefined(httpStatus);
+  if (!status) {
+    throw new Error(`httpStatus ${httpStatus} is not a supported CommunicationStatus.`);
+  }
+  return status;
+};
+var getCommunicationStatusDetails = (httpStatus) => {
+  if (!httpStatus) return { status: networkFailure, message: "network failure" };
+  const status = getCommunicationStatusFromHttpStatus(httpStatus);
   return {
     status,
     httpStatus,
     message: `${status} (${httpStatus})`
   };
 };
-var getCommunicationStatus = (httpStatus) => getCommunicationStatusDetails(httpStatus).status;
+var getCommunicationStatusOrUndefined = (status) => {
+  if (status == null) return void 0;
+  if (typeof status === "string") {
+    if (!isStatusValid(status)) {
+      return void 0;
+    }
+    return status;
+  }
+  if (typeof status === "number") {
+    return getCommunicationStatusFromHttpStatusOrUndefined(status);
+  }
+  return void 0;
+};
+var getCommunicationStatus = (status) => {
+  if (status == null) return void 0;
+  if (typeof status === "number") {
+    return getCommunicationStatusFromHttpStatus(status);
+  }
+  const communicationStatus = getCommunicationStatusOrUndefined(status);
+  if (!communicationStatus) {
+    throw new Error(`${status} is not a valid CommunicationStatus.`);
+  }
+  return communicationStatus;
+};
 var getHttpStatus = (status) => {
   const httpStatus = communicationStatuses[status]?.httpStatus;
   if (!httpStatus) throw new Error(`There is no valid HttpStatus for ${status}.`);
@@ -102,9 +129,13 @@ export {
   aborted,
   clientFailure,
   clientFailureNotAuthorized,
+  communicationStatuses,
   failure,
   getCommunicationStatus,
   getCommunicationStatusDetails,
+  getCommunicationStatusFromHttpStatus,
+  getCommunicationStatusFromHttpStatusOrUndefined,
+  getCommunicationStatusOrUndefined,
   getHttpStatus,
   isAborted,
   isClientFailure,

package/dist/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../src/CommunicationStatus.ts"],"sourcesContent":["interface CommunicationStatusInfo {\n httpStatus?: number\n failure?: boolean\n clientFailure?: boolean\n serverFailure?: boolean\n}\n\ninterface CommunicationStatuses {\n [key: string]: CommunicationStatusInfo\n}\n\nconst communicationStatuses: CommunicationStatuses = {\n success: { httpStatus: 200 },\n missing: { httpStatus: 404, failure: true },\n clientFailure: { httpStatus: 400, clientFailure: true, failure: true },\n clientFailureNotAuthorized: { httpStatus: 403, clientFailure: true, failure: true },\n serverFailure: { httpStatus: 500, failure: true, serverFailure: true },\n networkFailure: { failure: true },\n aborted: { failure: true },\n pending: {},\n failure: { httpStatus: 500, failure: true },\n timeoutFailure: { failure: true }\n}\n\nexport type CommunicationStatus = \"success\" \| \"missing\" \| \"clientFailure\" \| \"clientFailureNotAuthorized\" \| \"serverFailure\" \| \"networkFailure\" \| \"aborted\" \| \"pending\" \| \"failure\" \| \"timeoutFailure\"\n/*\n RegEx returns true for all valid communication statuses\n /\nexport const statusRegex = /^(success\|missing\|clientFailure\|clientFailureNotAuthorized\|serverFailure\|networkFailure\|aborted\|pending\|failure\|timeoutFailure)$/\n\n// Export status constants\n/\n HTTP 2xx responses\n \n Client Can Automatically:\n * - Process the successful response\n * - Update UI to reflect success\n \n Client Developer Can:\n * - Handle the successful response data\n /\nexport const success: CommunicationStatus = \"success\"\n\n/\n Resource not found\n \n HTTP Status Codes Covered:\n * - 404: Not Found\n \n Client Can Automatically:\n * - notify the user that the resource was not found\n * - prompt the user to request a different resource\n \n Client Developer Can:\n * - fix the bad resource paths\n /\nexport const missing: CommunicationStatus = \"missing\"\n\n/\n Client-side errors; i.e. the client needs to change the request somehow to succeed\n \n HTTP Status Codes Covered:\n * - 400: Bad Request\n * - 401: Unauthorized\n * - 403: Forbidden\n * - 407: Proxy Authentication Required\n * - 409: Conflict\n * - 422: Unprocessable Entity\n \n Client Can Automatically:\n * - Notify the user that the client is experiencing issues\n * - Prompt user to correct invalid input\n \n Client Developer Can:\n * - use isClientFailureNotAuthorized to check for 401/403/407/451\n * - fix the request to avoid the 4xx error\n * - validate input before sending requests\n /\nexport const clientFailure: CommunicationStatus = \"clientFailure\"\n\n/\n Unauthorized requests; i.e. client needs to change the credentials (or the grants for the current credentials) to succeed\n \n HTTP Status Codes Covered:\n * - 401: Unauthorized\n * - 403: Forbidden\n * - 407: Proxy Authentication Required\n * - 451: Unavailable For Legal Reasons\n \n Client Can Automatically:\n * - refresh the request token\n * - prompt the user to re-login\n * - ask the user to contact the administrator for access\n \n Client and Server Developer Can:\n * - fix authorization / authentication bugs\n /\nexport const clientFailureNotAuthorized: CommunicationStatus = \"clientFailureNotAuthorized\"\n\n/\n Server-side errors; i.e. internal server errors\n \n HTTP Status Codes Covered:\n * - 500: Internal Server Error\n * - 502: Bad Gateway\n * - 503: Service Unavailable\n * - 504: Gateway Timeout\n \n Client Can Automatically:\n * - Ask the user to try again later\n * - Notify the user that the server is experiencing issues\n * - Implement automatic retry with backoff\n \n Client Developer: (probably) can't fix\n \n Server Developer Can:\n * - fix the server to avoid the 5xx error\n * - fix server infrastructure to avoid the 5xx error\n /\nexport const serverFailure: CommunicationStatus = \"serverFailure\"\n\n/\n Request fails due to network connectivity issues\n \n HTTP Status Codes Covered: NONE (server was not reachable)\n \n Client Can Automatically:\n * - Prompt the user to fix the network connection\n * - Retry the request when network is available\n * - Monitor network status for recovery\n \n Client Developer Can:\n * - fix bad network constants (like address, ports, etc.)\n * - implement offline-first capabilities\n /\nexport const networkFailure: CommunicationStatus = \"networkFailure\"\n\n/\n Request was cancelled by client\n \n Client Can Automatically:\n * - notify the user that the request was cancelled\n * - prompt the user to try again\n * - cleanup any pending state\n \n Client Developer Can:\n * - fix the client to not abort the request unnecessarily\n * - implement proper cleanup on abort\n /\nexport const aborted: CommunicationStatus = \"aborted\"\n\n/\n Request is in progress\n \n Client Can Automatically:\n * - notify the user that the request is in progress\n * - show the user progress (if available)\n * - allow the user to cancel the request\n \n Client Developer Can:\n * - if \"pending\" was not expected, maybe the client needs to `wait` for the request to complete?\n * - implement proper loading states\n /\nexport const pending: CommunicationStatus = \"pending\"\n\n/\n Any error response (HTTP 4xx/5xx) or network/abort failures\n \n HTTP Status Codes Covered:\n * - 4xx: Client-side errors (except 404)\n * - 5xx: Server-side errors\n * - Network failures\n * - Abort failures\n \n Client Can Automatically:\n * - Show appropriate error message to user\n * - Implement generic error handling\n * - Log errors for debugging\n \n Client Developer Can:\n * - Use more specific is* functions for targeted error handling\n * - Implement proper error recovery strategies\n /\nexport const failure: CommunicationStatus = \"failure\"\n\n/\n Request timed out\n \n Client Can Automatically:\n * - notify the user that the request timed out\n * - try again (automatically or via user action)\n \n Client Developer Can:\n * - fix the client to not timeoutFailure the request\n * - implement proper timeoutFailure handling\n /\nexport const timeoutFailure: CommunicationStatus = \"timeoutFailure\"\n\n// Core status check functions\n/* Returns true for HTTP 2xx responses /\nexport const isSuccess = (status: CommunicationStatus) => status === success\n\n/\n Returns true for any error response (HTTP 4xx/5xx) or network/abort failures\n \n HTTP Status Codes Covered:\n * - 4xx: Client-side errors (except 404)\n * - 5xx: Server-side errors\n * - Network failures\n * - Abort failures\n \n Client Can:\n * - Use a different is* function for more specific checks\n /\nexport const isFailure = (status: CommunicationStatus) => !!communicationStatuses[status]?.failure\n\n/\n Returns true for client-side errors\n \n HTTP Status Codes Covered:\n * - 400: Bad Request\n * - 401: Unauthorized\n * - 403: Forbidden\n * - 407: Proxy Authentication Required\n * - 409: Conflict\n * - 422: Unprocessable Entity\n \n Client Can Automatically:\n * - Notify the user that the client is experiencing issues\n \n Client Developer Can:\n * - use isClientFailureNotAuthorized to check for 401/403/407/451\n * - fix the request to avoid the 4xx error\n/\nexport const isClientFailure = (status: CommunicationStatus) => !!communicationStatuses[status]?.clientFailure\n\n/\n Returns true for server-side errors\n \n HTTP Status Codes Covered:\n * - 500: Internal Server Error\n * - 502: Bad Gateway\n * - 503: Service Unavailable\n * - 504: Gateway Timeout\n \n Client Can Automatically:\n * - Ask the user to try again later\n * - Notify the user that the server is experiencing issues\n \n Client Developer: (probably) can't fix\n \n Server Developer Can:\n * - fix the server to avoid the 5xx error\n * - fix server infrastructure to avoid the 5xx error (e.g. Bad Gateway, Service Unavailable, Gateway Timeout)\n/\nexport const isServerFailure = (status: CommunicationStatus) => !!communicationStatuses[status]?.serverFailure\n\n/\n Returns true when request fails due to network connectivity issues\n \n HTTP Status Codes Covered: NONE (server was not reachable)\n \n Client Can Automatically:\n * - Prompt the user to fix the network connection\n * - Retry the request\n \n Client Developer Can:\n * - fix bad network constants (like address, ports, etc.)\n/\nexport const isNetworkFailure = (status: CommunicationStatus) => status === networkFailure\n\n/* Returns true for server errors, network failures and aborted requests; i.e. the client did nothing wrong (as far as we can tell); client can ask the user to do something OR retry the request /\nexport const isNonClientFailure = (status: CommunicationStatus) => isFailure(status) && !isClientFailure(status)\n\n/\n Returns true for unauthorized requests (not authenticated or not authorized)\n \n HTTP Status Codes Covered:\n * - 401: Unauthorized\n * - 403: Forbidden\n * - 407: Proxy Authentication Required\n * - 451: Unavailable For Legal Reasons\n * - 511: Network Authentication Required\n \n Client Can Automatically:\n * - refresh the request token\n * - prompt the user to re-login\n * - ask the user to contact the administrator for access\n \n Client and Server Developer Can:\n * - fix authorization / authentication bugs\n /\nexport const isClientFailureNotAuthorized = (status: CommunicationStatus) => status === clientFailureNotAuthorized\n\n/\n Returns true when request was cancelled by client\n \n Client Can Automatically:\n * - notify the user that the request was cancelled\n * - prompt the user to try again\n \n Client Developer Can:\n * - fix the client to not abort the request\n /\nexport const isAborted = (status: CommunicationStatus) => status === aborted\n\n/\n Returns true when resource not found / not available\n \n HTTP Status Codes Covered:\n * - 404: Not Found\n * - 501: Not Implemented\n \n Client Can Automatically:\n * - notify the user that the resource was not found\n * - prompt the user to request a different resource\n \n Client Developer Can:\n * - fix the bad resource paths\n /\nexport const isMissing = (status: CommunicationStatus) => status === missing\n\n/\n Returns true while request is in progress\n \n Client Can Automatically:\n * - notify the user that the request is in progress\n * - show the user progress (if available)\n * - allow the user to cancel the request (trigging an \"aborted\" communication status)\n \n Client Developer Can:\n * - if \"pending\" was not expected, maybe the client needs to `wait` for the request to complete?\n /\nexport const isPending = (status: CommunicationStatus) => status === pending\n\n/\n Returns true if the request timed out\n \n Client Can Automatically:\n * - notify the user that the request timed out\n * - try again (automatically or via user action)\n \n Client Developer Can:\n * - extend the timeoutFailure duration\n \n Server Developer Can:\n * - improve server performance and reliability\n /\nexport const isTimeout = (status: CommunicationStatus) => status === timeoutFailure\n\n/\n Returns true if client can safely retry the request\n \n A a clearly-retryable failure:\n \n - network failure\n * - timeoutFailure\n * - aborted\n \n Note: some serverFailures will succeed on retry, but HTTP doesn't return clear indications which ones. To be safe, the client should not retry serverFailures indiscriminately.\n \n Client and Server Devs can\n * - investigate network, client and server performance and reliability issues\n /\nexport const isRetryableFailure = (status: CommunicationStatus) => isNetworkFailure(status) \|\| isTimeout(status) \|\| isAborted(status)\n\n/\n Returns true if the status is a valid communication status\n /\nexport const isStatusValid = (status: string) => statusRegex.test(status);\n\ninterface CommunicationStatusDetails {\n status: CommunicationStatus\n httpStatus?: number\n message: string\n}\n\n/\n Returns CommunicationStatusDetails {status, httpStatus, message} given an HTTP status code\n \n Throws: Error if the HTTP status code is not supported (i.e. the 100 codes or non HTTP status code numbers)\n \n @param httpStatus - The HTTP status code to get the communication status for\n * @returns The communication status for the given HTTP status code\n */\nexport const getCommunicationStatusDetails = (httpStatus?: number): CommunicationStatusDetails => {\n if (!httpStatus) return { status: networkFailure, message: \"network failure\" }\n\n let status: CommunicationStatus \| undefined\n\n switch (Math.floor(httpStatus / 100)) {\n case 2: status = success; break\n case 3: status = missing; break\n case 4:\n switch (httpStatus) {\n case 401:\n case 403:\n case 407:\n case 451: status = clientFailureNotAuthorized; break\n case 404: status = missing; break\n default: status = clientFailure\n }\n break\n case 5:\n switch (httpStatus) {\n case 502:\n case 503:\n case 504: status = networkFailure; break\n case 511: status = clientFailureNotAuthorized; break\n case 501: status = missing; break // 501 Not Implemented - i.e. it \"does not exist\" currently - i.e. missing\n case 505: // HTTP Version Not Supported - client should change the request\n case 530: status = clientFailure; break\n default: status = serverFailure; break\n }\n break\n }\n\n if (!status) throw new Error(`httpStatus ${httpStatus} is not a supported CommunicationStatus.`)\n\n return {\n status,\n httpStatus,\n message: `${status} (${httpStatus})`\n }\n}\n\nexport const getCommunicationStatus = (httpStatus?: number): CommunicationStatus =>\n getCommunicationStatusDetails(httpStatus).status\n\nexport const getHttpStatus = (status: CommunicationStatus): number => {\n const httpStatus = communicationStatuses[status]?.httpStatus\n if (!httpStatus) throw new Error(`There is no valid HttpStatus for ${status}.`)\n return httpStatus\n}"],"mappings":";AAWA,IAAM,wBAA+C;AAAA,EACnD,SAAS,EAAE,YAAY,IAAI;AAAA,EAC3B,SAAS,EAAE,YAAY,KAAK,SAAS,KAAK;AAAA,EAC1C,eAAe,EAAE,YAAY,KAAK,eAAe,MAAM,SAAS,KAAK;AAAA,EACrE,4BAA4B,EAAE,YAAY,KAAK,eAAe,MAAM,SAAS,KAAK;AAAA,EAClF,eAAe,EAAE,YAAY,KAAK,SAAS,MAAM,eAAe,KAAK;AAAA,EACrE,gBAAgB,EAAE,SAAS,KAAK;AAAA,EAChC,SAAS,EAAE,SAAS,KAAK;AAAA,EACzB,SAAS,CAAC;AAAA,EACV,SAAS,EAAE,YAAY,KAAK,SAAS,KAAK;AAAA,EAC1C,gBAAgB,EAAE,SAAS,KAAK;AAClC;AAMO,IAAM,cAAc;AAapB,IAAM,UAA+B;AAerC,IAAM,UAA+B;AAsBrC,IAAM,gBAAqC;AAmB3C,IAAM,6BAAkD;AAsBxD,IAAM,gBAAqC;AAgB3C,IAAM,iBAAsC;AAc5C,IAAM,UAA+B;AAcrC,IAAM,UAA+B;AAoBrC,IAAM,UAA+B;AAarC,IAAM,iBAAsC;AAI5C,IAAM,YAAY,CAAC,WAAgC,WAAW;AAc9D,IAAM,YAAY,CAAC,WAAgC,CAAC,CAAC,sBAAsB,MAAM,GAAG;AAoBpF,IAAM,kBAAkB,CAAC,WAAgC,CAAC,CAAC,sBAAsB,MAAM,GAAG;AAqB1F,IAAM,kBAAkB,CAAC,WAAgC,CAAC,CAAC,sBAAsB,MAAM,GAAG;AAc1F,IAAM,mBAAmB,CAAC,WAAgC,WAAW;AAGrE,IAAM,qBAAqB,CAAC,WAAgC,UAAU,MAAM,KAAK,CAAC,gBAAgB,MAAM;AAoBxG,IAAM,+BAA+B,CAAC,WAAgC,WAAW;AAYjF,IAAM,YAAY,CAAC,WAAgC,WAAW;AAgB9D,IAAM,YAAY,CAAC,WAAgC,WAAW;AAa9D,IAAM,YAAY,CAAC,WAAgC,WAAW;AAe9D,IAAM,YAAY,CAAC,WAAgC,WAAW;AAgB9D,IAAM,qBAAqB,CAAC,WAAgC,iBAAiB,MAAM,KAAK,UAAU,MAAM,KAAK,UAAU,MAAM;AAK7H,IAAM,gBAAgB,CAAC,WAAmB,YAAY,KAAK,MAAM;AAgBjE,IAAM,gCAAgC,CAAC,eAAoD;AAChG,MAAI,CAAC,WAAY,QAAO,EAAE,QAAQ,gBAAgB,SAAS,kBAAkB;AAE7E,MAAI;AAEJ,UAAQ,KAAK,MAAM,aAAa,GAAG,GAAG;AAAA,IACpC,KAAK;AAAG,eAAS;AAAS;AAAA,IAC1B,KAAK;AAAG,eAAS;AAAS;AAAA,IAC1B,KAAK;AACH,cAAQ,YAAY;AAAA,QAClB,KAAK;AAAA,QACL,KAAK;AAAA,QACL,KAAK;AAAA,QACL,KAAK;AAAK,mBAAS;AAA4B;AAAA,QAC/C,KAAK;AAAK,mBAAS;AAAS;AAAA,QAC5B;AAAS,mBAAS;AAAA,MACpB;AACA;AAAA,IACF,KAAK;AACH,cAAQ,YAAY;AAAA,QAClB,KAAK;AAAA,QACL,KAAK;AAAA,QACL,KAAK;AAAK,mBAAS;AAAgB;AAAA,QACnC,KAAK;AAAK,mBAAS;AAA4B;AAAA,QAC/C,KAAK;AAAK,mBAAS;AAAS;AAAA;AAAA,QAC5B,KAAK;AAAA;AAAA,QACL,KAAK;AAAK,mBAAS;AAAe;AAAA,QAClC;AAAS,mBAAS;AAAe;AAAA,MACnC;AACA;AAAA,EACJ;AAEA,MAAI,CAAC,OAAQ,OAAM,IAAI,MAAM,cAAc,UAAU,0CAA0C;AAE/F,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,SAAS,GAAG,MAAM,KAAK,UAAU;AAAA,EACnC;AACF;AAEO,IAAM,yBAAyB,CAAC,eACrC,8BAA8B,UAAU,EAAE;AAErC,IAAM,gBAAgB,CAAC,WAAwC;AACpE,QAAM,aAAa,sBAAsB,MAAM,GAAG;AAClD,MAAI,CAAC,WAAY,OAAM,IAAI,MAAM,oCAAoC,MAAM,GAAG;AAC9E,SAAO;AACT;","names":[]}
1	+ {"version":3,"sources":["../src/CommunicationStatusConsts.ts","../src/CommunicationStatusTypes.ts","../src/CommunicationStatusTests.ts","../src/CommunicationStatus.ts"],"sourcesContent":["// Export status constants\nimport type { CommunicationStatus } from './CommunicationStatusTypes'\n\n/*\n HTTP 2xx responses\n \n Client Can Automatically:\n * - Process the successful response\n * - Update UI to reflect success\n \n Client Developer Can:\n * - Handle the successful response data\n /\nexport const success: CommunicationStatus = \"success\"\n\n/\n Resource not found\n \n HTTP Status Codes Covered:\n * - 404: Not Found\n \n Client Can Automatically:\n * - notify the user that the resource was not found\n * - prompt the user to request a different resource\n \n Client Developer Can:\n * - fix the bad resource paths\n /\nexport const missing: CommunicationStatus = \"missing\"\n\n/\n Client-side errors; i.e. the client needs to change the request somehow to succeed\n \n HTTP Status Codes Covered:\n * - 400: Bad Request\n * - 401: Unauthorized\n * - 403: Forbidden\n * - 407: Proxy Authentication Required\n * - 409: Conflict\n * - 422: Unprocessable Entity\n \n Client Can Automatically:\n * - Notify the user that the client is experiencing issues\n * - Prompt user to correct invalid input\n \n Client Developer Can:\n * - use isClientFailureNotAuthorized to check for 401/403/407/451\n * - fix the request to avoid the 4xx error\n * - validate input before sending requests\n /\nexport const clientFailure: CommunicationStatus = \"clientFailure\"\n\n/\n Unauthorized requests; i.e. client needs to change the credentials (or the grants for the current credentials) to succeed\n \n HTTP Status Codes Covered:\n * - 401: Unauthorized\n * - 403: Forbidden\n * - 407: Proxy Authentication Required\n * - 451: Unavailable For Legal Reasons\n \n Client Can Automatically:\n * - refresh the request token\n * - prompt the user to re-login\n * - ask the user to contact the administrator for access\n \n Client and Server Developer Can:\n * - fix authorization / authentication bugs\n /\nexport const clientFailureNotAuthorized: CommunicationStatus = \"clientFailureNotAuthorized\"\n\n/\n Server-side errors; i.e. internal server errors\n \n HTTP Status Codes Covered:\n * - 500: Internal Server Error\n * - 502: Bad Gateway\n * - 503: Service Unavailable\n * - 504: Gateway Timeout\n \n Client Can Automatically:\n * - Ask the user to try again later\n * - Notify the user that the server is experiencing issues\n * - Implement automatic retry with backoff\n \n Client Developer: (probably) can't fix\n \n Server Developer Can:\n * - fix the server to avoid the 5xx error\n * - fix server infrastructure to avoid the 5xx error\n /\nexport const serverFailure: CommunicationStatus = \"serverFailure\"\n\n/\n Request fails due to network connectivity issues\n \n HTTP Status Codes Covered: NONE (server was not reachable)\n \n Client Can Automatically:\n * - Prompt the user to fix the network connection\n * - Retry the request when network is available\n * - Monitor network status for recovery\n \n Client Developer Can:\n * - fix bad network constants (like address, ports, etc.)\n * - implement offline-first capabilities\n /\nexport const networkFailure: CommunicationStatus = \"networkFailure\"\n\n/\n Request was cancelled by client\n \n Client Can Automatically:\n * - notify the user that the request was cancelled\n * - prompt the user to try again\n * - cleanup any pending state\n \n Client Developer Can:\n * - fix the client to not abort the request unnecessarily\n * - implement proper cleanup on abort\n /\nexport const aborted: CommunicationStatus = \"aborted\"\n\n/\n Request is in progress\n \n Client Can Automatically:\n * - notify the user that the request is in progress\n * - show the user progress (if available)\n * - allow the user to cancel the request\n \n Client Developer Can:\n * - if \"pending\" was not expected, maybe the client needs to `wait` for the request to complete?\n * - implement proper loading states\n /\nexport const pending: CommunicationStatus = \"pending\"\n\n/\n Any error response (HTTP 4xx/5xx) or network/abort failures\n \n HTTP Status Codes Covered:\n * - 4xx: Client-side errors (except 404)\n * - 5xx: Server-side errors\n * - Network failures\n * - Abort failures\n \n Client Can Automatically:\n * - Show appropriate error message to user\n * - Implement generic error handling\n * - Log errors for debugging\n \n Client Developer Can:\n * - Use more specific is* functions for targeted error handling\n * - Implement proper error recovery strategies\n /\nexport const failure: CommunicationStatus = \"failure\"\n\n/\n Request timed out\n \n Client Can Automatically:\n * - notify the user that the request timed out\n * - try again (automatically or via user action)\n \n Client Developer Can:\n * - fix the client to not timeoutFailure the request\n * - implement proper timeoutFailure handling\n /\nexport const timeoutFailure: CommunicationStatus = \"timeoutFailure\"\n","interface CommunicationStatusInfo {\n httpStatus?: number\n failure?: boolean\n clientFailure?: boolean\n serverFailure?: boolean\n}\n\nexport const communicationStatuses: Record<string, CommunicationStatusInfo> = {\n success: { httpStatus: 200 },\n missing: { httpStatus: 404, failure: true },\n clientFailure: { httpStatus: 400, clientFailure: true, failure: true },\n clientFailureNotAuthorized: { httpStatus: 403, clientFailure: true, failure: true },\n serverFailure: { httpStatus: 500, failure: true, serverFailure: true },\n networkFailure: { failure: true },\n aborted: { failure: true },\n pending: {},\n failure: { httpStatus: 500, failure: true },\n timeoutFailure: { failure: true }\n}\n\nexport type CommunicationStatuses = typeof communicationStatuses\nexport type CommunicationStatus = keyof CommunicationStatuses\n\n/\n RegEx returns true for all valid communication statuses\n /\nexport const statusRegex = new RegExp(`^(${Object.keys(communicationStatuses).join('\|')})$`)\n\nexport interface CommunicationStatusDetails {\n status: CommunicationStatus\n httpStatus?: number\n message: string\n}\n","import { communicationStatuses, CommunicationStatus, statusRegex } from './CommunicationStatusTypes'\nimport { success, missing, clientFailure, clientFailureNotAuthorized, serverFailure, networkFailure, aborted, pending, timeoutFailure } from './CommunicationStatusConsts'\n\n// Core status check functions\n/* Returns true for HTTP 2xx responses /\nexport const isSuccess = (status: CommunicationStatus) => status === success\n\n/\n Returns true for any error response (HTTP 4xx/5xx) or network/abort failures\n \n HTTP Status Codes Covered:\n * - 4xx: Client-side errors (except 404)\n * - 5xx: Server-side errors\n * - Network failures\n * - Abort failures\n \n Client Can:\n * - Use a different is* function for more specific checks\n /\nexport const isFailure = (status: CommunicationStatus) => !!communicationStatuses[status]?.failure\n\n/\n Returns true for client-side errors\n \n HTTP Status Codes Covered:\n * - 400: Bad Request\n * - 401: Unauthorized\n * - 403: Forbidden\n * - 407: Proxy Authentication Required\n * - 409: Conflict\n * - 422: Unprocessable Entity\n \n Client Can Automatically:\n * - Notify the user that the client is experiencing issues\n \n Client Developer Can:\n * - use isClientFailureNotAuthorized to check for 401/403/407/451\n * - fix the request to avoid the 4xx error\n/\nexport const isClientFailure = (status: CommunicationStatus) => !!communicationStatuses[status]?.clientFailure\n\n/\n Returns true for server-side errors\n \n HTTP Status Codes Covered:\n * - 500: Internal Server Error\n * - 502: Bad Gateway\n * - 503: Service Unavailable\n * - 504: Gateway Timeout\n \n Client Can Automatically:\n * - Ask the user to try again later\n * - Notify the user that the server is experiencing issues\n \n Client Developer: (probably) can't fix\n \n Server Developer Can:\n * - fix the server to avoid the 5xx error\n * - fix server infrastructure to avoid the 5xx error (e.g. Bad Gateway, Service Unavailable, Gateway Timeout)\n/\nexport const isServerFailure = (status: CommunicationStatus) => !!communicationStatuses[status]?.serverFailure\n\n/\n Returns true when request fails due to network connectivity issues\n \n HTTP Status Codes Covered: NONE (server was not reachable)\n \n Client Can Automatically:\n * - Prompt the user to fix the network connection\n * - Retry the request\n \n Client Developer Can:\n * - fix bad network constants (like address, ports, etc.)\n/\nexport const isNetworkFailure = (status: CommunicationStatus) => status === networkFailure\n\n/* Returns true for server errors, network failures and aborted requests; i.e. the client did nothing wrong (as far as we can tell); client can ask the user to do something OR retry the request /\nexport const isNonClientFailure = (status: CommunicationStatus) => isFailure(status) && !isClientFailure(status)\n\n/\n Returns true for unauthorized requests (not authenticated or not authorized)\n \n HTTP Status Codes Covered:\n * - 401: Unauthorized\n * - 403: Forbidden\n * - 407: Proxy Authentication Required\n * - 451: Unavailable For Legal Reasons\n * - 511: Network Authentication Required\n \n Client Can Automatically:\n * - refresh the request token\n * - prompt the user to re-login\n * - ask the user to contact the administrator for access\n \n Client and Server Developer Can:\n * - fix authorization / authentication bugs\n /\nexport const isClientFailureNotAuthorized = (status: CommunicationStatus) => status === clientFailureNotAuthorized\n\n/\n Returns true when request was cancelled by client\n \n Client Can Automatically:\n * - notify the user that the request was cancelled\n * - prompt the user to try again\n \n Client Developer Can:\n * - fix the client to not abort the request\n /\nexport const isAborted = (status: CommunicationStatus) => status === aborted\n\n/\n Returns true when resource not found / not available\n \n HTTP Status Codes Covered:\n * - 404: Not Found\n * - 501: Not Implemented\n \n Client Can Automatically:\n * - notify the user that the resource was not found\n * - prompt the user to request a different resource\n \n Client Developer Can:\n * - fix the bad resource paths\n /\nexport const isMissing = (status: CommunicationStatus) => status === missing\n\n/\n Returns true while request is in progress\n \n Client Can Automatically:\n * - notify the user that the request is in progress\n * - show the user progress (if available)\n * - allow the user to cancel the request (trigging an \"aborted\" communication status)\n \n Client Developer Can:\n * - if \"pending\" was not expected, maybe the client needs to `wait` for the request to complete?\n /\nexport const isPending = (status: CommunicationStatus) => status === pending\n\n/\n Returns true if the request timed out\n \n Client Can Automatically:\n * - notify the user that the request timed out\n * - try again (automatically or via user action)\n \n Client Developer Can:\n * - extend the timeoutFailure duration\n \n Server Developer Can:\n * - improve server performance and reliability\n /\nexport const isTimeout = (status: CommunicationStatus) => status === timeoutFailure\n\n/\n Returns true if client can safely retry the request\n \n A a clearly-retryable failure:\n \n - network failure\n * - timeoutFailure\n * - aborted\n \n Note: some serverFailures will succeed on retry, but HTTP doesn't return clear indications which ones. To be safe, the client should not retry serverFailures indiscriminately.\n \n Client and Server Devs can\n * - investigate network, client and server performance and reliability issues\n /\nexport const isRetryableFailure = (status: CommunicationStatus) => isNetworkFailure(status) \|\| isTimeout(status) \|\| isAborted(status)\n\n/\n Returns true if the status is a valid communication status\n /\nexport const isStatusValid = (status: string) => statusRegex.test(status);\n","import { clientFailure, clientFailureNotAuthorized, missing, networkFailure, serverFailure, success } from './CommunicationStatusConsts';\nimport { isStatusValid } from './CommunicationStatusTests';\nimport { CommunicationStatus, CommunicationStatusDetails, communicationStatuses } from './CommunicationStatusTypes';\n\nexport const getCommunicationStatusFromHttpStatusOrUndefined = (httpStatus: number): CommunicationStatus \| undefined => {\n switch (Math.floor(httpStatus / 100)) {\n case 2: return success;\n case 3: return missing;\n case 4:\n switch (httpStatus) {\n case 401:\n case 403:\n case 407:\n case 451: return clientFailureNotAuthorized;\n case 404: return missing;\n default: return clientFailure;\n }\n case 5:\n switch (httpStatus) {\n case 502:\n case 503:\n case 504: return networkFailure;\n case 511: return clientFailureNotAuthorized;\n case 501: return missing; // 501 Not Implemented - i.e. it \"does not exist\" currently - i.e. missing\n case 505: // HTTP Version Not Supported - client should change the request\n case 530: return clientFailure;\n default: return serverFailure;\n }\n }\n return undefined;\n};\n\nexport const getCommunicationStatusFromHttpStatus = (httpStatus: number): CommunicationStatus => {\n const status = getCommunicationStatusFromHttpStatusOrUndefined(httpStatus);\n if (!status) {\n throw new Error(`httpStatus ${httpStatus} is not a supported CommunicationStatus.`);\n }\n return status;\n};\n\n/\n Returns CommunicationStatusDetails {status, httpStatus, message} given an HTTP status code\n \n Throws: Error if the HTTP status code is not supported (i.e. the 100 codes or non HTTP status code numbers)\n \n @param httpStatus - The HTTP status code to get the communication status for\n * @returns The communication status for the given HTTP status code\n */\nexport const getCommunicationStatusDetails = (httpStatus?: number): CommunicationStatusDetails => {\n if (!httpStatus) return { status: networkFailure, message: \"network failure\" };\n\n const status = getCommunicationStatusFromHttpStatus(httpStatus);\n\n return {\n status,\n httpStatus,\n message: `${status} (${httpStatus})`\n };\n};\n\nexport const getCommunicationStatusOrUndefined = <T extends number \| CommunicationStatus \| null \| undefined>(\n status: T\n): T extends null \| undefined ? undefined : (CommunicationStatus \| undefined) => {\n if (status == null) return undefined as any;\n if (typeof status === 'string') {\n if (!isStatusValid(status)) {\n return undefined;\n }\n return status as any;\n }\n if (typeof status === 'number') {\n return getCommunicationStatusFromHttpStatusOrUndefined(status) as any;\n }\n return undefined;\n};\n\nexport const getCommunicationStatus = <T extends number \| CommunicationStatus \| null \| undefined>(\n status: T\n): T extends null \| undefined ? undefined : CommunicationStatus => {\n if (status == null) return undefined as any;\n if (typeof status === 'number') {\n return getCommunicationStatusFromHttpStatus(status) as any;\n }\n const communicationStatus: CommunicationStatus \| undefined = getCommunicationStatusOrUndefined(status);\n if (!communicationStatus) {\n throw new Error(`${status} is not a valid CommunicationStatus.`);\n }\n return communicationStatus as any;\n};\n\nexport const getHttpStatus = (status: CommunicationStatus): number => {\n const httpStatus = communicationStatuses[status]?.httpStatus;\n if (!httpStatus) throw new Error(`There is no valid HttpStatus for ${status}.`);\n return httpStatus;\n};\n"],"mappings":";AAaO,IAAM,UAA+B;AAerC,IAAM,UAA+B;AAsBrC,IAAM,gBAAqC;AAmB3C,IAAM,6BAAkD;AAsBxD,IAAM,gBAAqC;AAgB3C,IAAM,iBAAsC;AAc5C,IAAM,UAA+B;AAcrC,IAAM,UAA+B;AAoBrC,IAAM,UAA+B;AAarC,IAAM,iBAAsC;;;ACjK5C,IAAM,wBAAiE;AAAA,EAC5E,SAAS,EAAE,YAAY,IAAI;AAAA,EAC3B,SAAS,EAAE,YAAY,KAAK,SAAS,KAAK;AAAA,EAC1C,eAAe,EAAE,YAAY,KAAK,eAAe,MAAM,SAAS,KAAK;AAAA,EACrE,4BAA4B,EAAE,YAAY,KAAK,eAAe,MAAM,SAAS,KAAK;AAAA,EAClF,eAAe,EAAE,YAAY,KAAK,SAAS,MAAM,eAAe,KAAK;AAAA,EACrE,gBAAgB,EAAE,SAAS,KAAK;AAAA,EAChC,SAAS,EAAE,SAAS,KAAK;AAAA,EACzB,SAAS,CAAC;AAAA,EACV,SAAS,EAAE,YAAY,KAAK,SAAS,KAAK;AAAA,EAC1C,gBAAgB,EAAE,SAAS,KAAK;AAClC;AAQO,IAAM,cAAc,IAAI,OAAO,KAAK,OAAO,KAAK,qBAAqB,EAAE,KAAK,GAAG,CAAC,IAAI;;;ACrBpF,IAAM,YAAY,CAAC,WAAgC,WAAW;AAc9D,IAAM,YAAY,CAAC,WAAgC,CAAC,CAAC,sBAAsB,MAAM,GAAG;AAoBpF,IAAM,kBAAkB,CAAC,WAAgC,CAAC,CAAC,sBAAsB,MAAM,GAAG;AAqB1F,IAAM,kBAAkB,CAAC,WAAgC,CAAC,CAAC,sBAAsB,MAAM,GAAG;AAc1F,IAAM,mBAAmB,CAAC,WAAgC,WAAW;AAGrE,IAAM,qBAAqB,CAAC,WAAgC,UAAU,MAAM,KAAK,CAAC,gBAAgB,MAAM;AAoBxG,IAAM,+BAA+B,CAAC,WAAgC,WAAW;AAYjF,IAAM,YAAY,CAAC,WAAgC,WAAW;AAgB9D,IAAM,YAAY,CAAC,WAAgC,WAAW;AAa9D,IAAM,YAAY,CAAC,WAAgC,WAAW;AAe9D,IAAM,YAAY,CAAC,WAAgC,WAAW;AAgB9D,IAAM,qBAAqB,CAAC,WAAgC,iBAAiB,MAAM,KAAK,UAAU,MAAM,KAAK,UAAU,MAAM;AAK7H,IAAM,gBAAgB,CAAC,WAAmB,YAAY,KAAK,MAAM;;;AC1KjE,IAAM,kDAAkD,CAAC,eAAwD;AACtH,UAAQ,KAAK,MAAM,aAAa,GAAG,GAAG;AAAA,IACpC,KAAK;AAAG,aAAO;AAAA,IACf,KAAK;AAAG,aAAO;AAAA,IACf,KAAK;AACH,cAAQ,YAAY;AAAA,QAClB,KAAK;AAAA,QACL,KAAK;AAAA,QACL,KAAK;AAAA,QACL,KAAK;AAAK,iBAAO;AAAA,QACjB,KAAK;AAAK,iBAAO;AAAA,QACjB;AAAS,iBAAO;AAAA,MAClB;AAAA,IACF,KAAK;AACH,cAAQ,YAAY;AAAA,QAClB,KAAK;AAAA,QACL,KAAK;AAAA,QACL,KAAK;AAAK,iBAAO;AAAA,QACjB,KAAK;AAAK,iBAAO;AAAA,QACjB,KAAK;AAAK,iBAAO;AAAA;AAAA,QACjB,KAAK;AAAA;AAAA,QACL,KAAK;AAAK,iBAAO;AAAA,QACjB;AAAS,iBAAO;AAAA,MAClB;AAAA,EACJ;AACA,SAAO;AACT;AAEO,IAAM,uCAAuC,CAAC,eAA4C;AAC/F,QAAM,SAAS,gDAAgD,UAAU;AACzE,MAAI,CAAC,QAAQ;AACX,UAAM,IAAI,MAAM,cAAc,UAAU,0CAA0C;AAAA,EACpF;AACA,SAAO;AACT;AAUO,IAAM,gCAAgC,CAAC,eAAoD;AAChG,MAAI,CAAC,WAAY,QAAO,EAAE,QAAQ,gBAAgB,SAAS,kBAAkB;AAE7E,QAAM,SAAS,qCAAqC,UAAU;AAE9D,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,SAAS,GAAG,MAAM,KAAK,UAAU;AAAA,EACnC;AACF;AAEO,IAAM,oCAAoC,CAC/C,WAC+E;AAC/E,MAAI,UAAU,KAAM,QAAO;AAC3B,MAAI,OAAO,WAAW,UAAU;AAC9B,QAAI,CAAC,cAAc,MAAM,GAAG;AAC1B,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AACA,MAAI,OAAO,WAAW,UAAU;AAC9B,WAAO,gDAAgD,MAAM;AAAA,EAC/D;AACA,SAAO;AACT;AAEO,IAAM,yBAAyB,CACpC,WACiE;AACjE,MAAI,UAAU,KAAM,QAAO;AAC3B,MAAI,OAAO,WAAW,UAAU;AAC9B,WAAO,qCAAqC,MAAM;AAAA,EACpD;AACA,QAAM,sBAAuD,kCAAkC,MAAM;AACrG,MAAI,CAAC,qBAAqB;AACxB,UAAM,IAAI,MAAM,GAAG,MAAM,sCAAsC;AAAA,EACjE;AACA,SAAO;AACT;AAEO,IAAM,gBAAgB,CAAC,WAAwC;AACpE,QAAM,aAAa,sBAAsB,MAAM,GAAG;AAClD,MAAI,CAAC,WAAY,OAAM,IAAI,MAAM,oCAAoC,MAAM,GAAG;AAC9E,SAAO;AACT;","names":[]}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@art-suite/art-core-ts-communication-status",
-  "version": "0.3.9",
+  "version": "0.4.2",
   "description": "A TypeScript string utility library",
   "keywords": [],
   "repository": {