@outfoxx/sunday 1.1.0-alpha.9 → 1.1.0-beta.2

package/src/fetch.ts

@@ -1,27 +1,46 @@
+// Copyright 2020 Outfox, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 import { ConstructableClassType } from './class-type';
 import { MediaType } from './media-type';
 import { Problem } from './problem';
 import { SundayError } from './sunday-error';
 import { Base64 } from './util/base64';
+import { errorToMessage } from './util/error';
 
 export async function validate(
   response: Response,
   dataExpected: boolean,
-  problemTypes?: Map<string, ConstructableClassType<Problem>>
+  problemTypes?: Map<string, ConstructableClassType<Problem>>,
 ): Promise<Response> {
   if (response.status < 200 || response.status >= 300) {
     const mediaType = MediaType.from(
       response.headers.get('content-type'),
-      MediaType.OctetStream
+      MediaType.OctetStream,
     );
-    const isProblemJSON = mediaType?.compatible(MediaType.ProblemJSON) ?? false;
-    if (!isProblemJSON) {
+    const isProblem = mediaType?.compatible(MediaType.Problem) ?? false;
+    if (!isProblem) {
       throw await Problem.fromResponse(response);
     }
 
     const problemData = await response.json();
     const problemType = problemTypes?.get(problemData.type) ?? Problem;
-    throw new problemType(problemData as Problem);
+    if (problemType.name === 'Problem') {
+      throw new Problem(problemData);
+    } else {
+      throw new problemType(problemData?.instance);
+    }
   }
 
   if (dataExpected && (response.status === 204 || response.status === 205)) {
@@ -45,7 +64,7 @@ export namespace ResponseExample {
 
   export async function bodyExcerpt(
     response: Response,
-    maxLength: number
+    maxLength: number,
   ): Promise<[string, unknown]> {
     let body: unknown;
     let bodyExcerpt: string;
@@ -70,9 +89,9 @@ export namespace ResponseExample {
           bodyExcerpt = Base64.encode(dataSlice);
         }
       }
-    } catch (e) {
+    } catch (error) {
       // ignore errors
-      const message = e.message || e.toString();
+      const message = errorToMessage(error);
       body = bodyExcerpt = `<<error displaying response data: ${message}>>`;
     }
     return [bodyExcerpt, body];

package/src/header-parameters.ts

@@ -1,6 +1,20 @@
+// Copyright 2020 Outfox, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 export namespace HeaderParameters {
   export function encode(
-    parameters?: Record<string, unknown>
+    parameters?: Record<string, unknown>,
   ): [string, string][] {
     if (parameters == null) {
       return [];
@@ -44,7 +58,7 @@ export namespace HeaderParameters {
   function validate(name: string, value: string): string {
     if (!asciiRegex.test(value)) {
       throw new Error(
-        `The encoded header value contains one or more invalid characters: header=${name}, value=${value}`
+        `The encoded header value contains one or more invalid characters: header=${name}, value=${value}`,
       );
     }
     return value;

package/src/index.ts

@@ -1,3 +1,17 @@
+// Copyright 2020 Outfox, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 export * from './any-type';
 export * from './class-type';
 export * from './request-factory';
@@ -20,6 +34,7 @@ export * from './logger';
 export * from './sunday-error';
 export * from './problem';
 export * from './date-time-types';
+export * from './result-response';
 
 export * from './util/base64';
 export * from './util/hex';

package/src/logger.ts

@@ -1,3 +1,17 @@
+// Copyright 2020 Outfox, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 export interface Logger {
   trace?(...data: unknown[]): void;
   debug?(...data: unknown[]): void;

package/src/media-type-codecs/any-text-decoder.ts

@@ -0,0 +1,34 @@
+// Copyright 2020 Outfox, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import { AnyType } from '../any-type';
+import { TextMediaTypeDecoder } from './media-type-decoder';
+
+export class AnyTextDecoder implements TextMediaTypeDecoder {
+  static default = new AnyTextDecoder();
+
+  async decode<T>(response: Response, type: AnyType): Promise<T> {
+    if (type[0] != String) {
+      throw Error('Invalid type, expected String');
+    }
+    return (await response.text()) as unknown as T;
+  }
+
+  decodeText<T>(text: string, type: AnyType): T {
+    if (type[0] != String) {
+      throw Error('Invalid type, expected String');
+    }
+    return text as unknown as T;
+  }
+}

package/src/media-type-codecs/any-text-encoder.ts

@@ -0,0 +1,26 @@
+// Copyright 2020 Outfox, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import { MediaTypeEncoder } from './media-type-encoder';
+
+export class AnyTextEncoder implements MediaTypeEncoder {
+  static default = new AnyTextEncoder();
+
+  encode(value: unknown): BodyInit {
+    if (typeof value != 'string') {
+      throw Error('Invalid value, expected string');
+    }
+    return value;
+  }
+}

package/src/media-type-codecs/binary-decoder.ts

@@ -1,3 +1,17 @@
+// Copyright 2020 Outfox, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 import { MediaTypeDecoder } from './media-type-decoder';
 import { AnyConstructableType } from '../any-type';
 
@@ -18,7 +32,7 @@ export class BinaryDecoder implements MediaTypeDecoder {
     }
 
     throw Error(
-      'Invalid value, expected ArrayBuffer, (Int|Uint)Array or DataView'
+      'Invalid value, expected ArrayBuffer, (Int|Uint)Array or DataView',
     );
   }
 }

package/src/media-type-codecs/binary-encoder.ts

@@ -1,3 +1,17 @@
+// Copyright 2020 Outfox, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 import { MediaTypeEncoder } from './media-type-encoder';
 
 export class BinaryEncoder implements MediaTypeEncoder {
@@ -11,7 +25,7 @@ export class BinaryEncoder implements MediaTypeEncoder {
       !(value instanceof ReadableStream)
     ) {
       throw Error(
-        'Invalid value, expected BufferSource, Blob or ReadableStream'
+        'Invalid value, expected BufferSource, Blob or ReadableStream',
       );
     }
     return value;

package/src/media-type-codecs/cbor-decoder.ts

@@ -1,3 +1,17 @@
+// Copyright 2020 Outfox, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 import {
   DateTimeFormatter,
   DateTimeFormatterBuilder,
@@ -25,7 +39,7 @@ import { MediaTypeDecoder } from './media-type-decoder';
 export class CBORDecoder implements MediaTypeDecoder {
   static get default(): CBORDecoder {
     return new CBORDecoder(
-      CBORDecoder.NumericDateDecoding.DECIMAL_SECONDS_SINCE_EPOCH
+      CBORDecoder.NumericDateDecoding.DECIMAL_SECONDS_SINCE_EPOCH,
     );
   }
 
@@ -156,7 +170,7 @@ export class CBORDecoder implements MediaTypeDecoder {
 
   private zonedDateTimeDeserializer: Deserializer = (
     key: string,
-    value: unknown
+    value: unknown,
   ) => {
     if (value == null) {
       return value;
@@ -185,7 +199,7 @@ export class CBORDecoder implements MediaTypeDecoder {
         const duration = Duration.parse(`PT${value}S`);
         const instant = Instant.ofEpochSecond(
           duration.seconds(),
-          duration.nano()
+          duration.nano(),
         );
         return ZonedDateTime.ofInstant(instant, ZoneId.UTC);
       } else {
@@ -194,7 +208,7 @@ export class CBORDecoder implements MediaTypeDecoder {
     }
     if (typeof value === 'string') {
       return ZonedDateTime.from(
-        DateTimeFormatter.ISO_ZONED_DATE_TIME.parse(value)
+        DateTimeFormatter.ISO_ZONED_DATE_TIME.parse(value),
       );
     }
     throw new Error(`Invalid date value for property ${key}`);
@@ -202,7 +216,7 @@ export class CBORDecoder implements MediaTypeDecoder {
 
   private offsetDateTimeDeserializer: Deserializer = (
     key: string,
-    value: unknown
+    value: unknown,
   ) => {
     if (value == null) {
       return value;
@@ -234,7 +248,7 @@ export class CBORDecoder implements MediaTypeDecoder {
         const duration = Duration.parse(`PT${value}S`);
         const instant = Instant.ofEpochSecond(
           duration.seconds(),
-          duration.nano()
+          duration.nano(),
         );
         return OffsetDateTime.ofInstant(instant, ZoneId.UTC);
       } else {
@@ -243,7 +257,7 @@ export class CBORDecoder implements MediaTypeDecoder {
     }
     if (typeof value === 'string') {
       return OffsetDateTime.from(
-        DateTimeFormatter.ISO_OFFSET_DATE_TIME.parse(value)
+        DateTimeFormatter.ISO_OFFSET_DATE_TIME.parse(value),
       );
     }
     throw new Error(`Invalid date value for property ${key}`);
@@ -257,7 +271,7 @@ export class CBORDecoder implements MediaTypeDecoder {
 
   private offsetTimeDeserializer: Deserializer = (
     key: string,
-    value: unknown
+    value: unknown,
   ) => {
     if (value == null) {
       return value;
@@ -290,7 +304,7 @@ export class CBORDecoder implements MediaTypeDecoder {
         minute,
         second,
         nanoOfSecond,
-        ZoneOffset.of(offset)
+        ZoneOffset.of(offset),
       );
     }
     if (typeof value === 'string') {
@@ -301,7 +315,7 @@ export class CBORDecoder implements MediaTypeDecoder {
 
   private localDateTimeDeserializer: Deserializer = (
     key: string,
-    value: unknown
+    value: unknown,
   ) => {
     if (value == null) {
       return value;
@@ -342,12 +356,12 @@ export class CBORDecoder implements MediaTypeDecoder {
         hour,
         minute,
         second,
-        nanoOfSecond
+        nanoOfSecond,
       );
     }
     if (typeof value === 'string') {
       return LocalDateTime.from(
-        DateTimeFormatter.ISO_LOCAL_DATE_TIME.parse(value)
+        DateTimeFormatter.ISO_LOCAL_DATE_TIME.parse(value),
       );
     }
     throw new Error(`Invalid date value for property ${key}`);
@@ -355,7 +369,7 @@ export class CBORDecoder implements MediaTypeDecoder {
 
   private localDateDeserializer: Deserializer = (
     key: string,
-    value: unknown
+    value: unknown,
   ) => {
     if (value == null) {
       return value;
@@ -384,7 +398,7 @@ export class CBORDecoder implements MediaTypeDecoder {
 
   private localTimeDeserializer: Deserializer = (
     key: string,
-    value: unknown
+    value: unknown,
   ) => {
     if (value == null) {
       return value;
@@ -475,7 +489,7 @@ export class CBORDecoder implements MediaTypeDecoder {
 
   private arrayBufferDeserializer: Deserializer = (
     key: string,
-    value: unknown
+    value: unknown,
   ) => {
     if (value == null) {
       return value;
@@ -486,7 +500,7 @@ export class CBORDecoder implements MediaTypeDecoder {
     if (ArrayBuffer.isView(value)) {
       return value.buffer.slice(
         value.byteOffset,
-        value.byteOffset + value.byteLength
+        value.byteOffset + value.byteLength,
       );
     }
     if (typeof value === 'string') {

package/src/media-type-codecs/cbor-encoder.ts

@@ -1,3 +1,17 @@
+// Copyright 2020 Outfox, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 import {
   ChronoField,
   DateTimeFormatter,
@@ -24,7 +38,7 @@ import { MediaTypeEncoder } from './media-type-encoder';
 export class CBOREncoder implements MediaTypeEncoder {
   static get default(): CBOREncoder {
     return new CBOREncoder(
-      CBOREncoder.DateEncoding.DECIMAL_SECONDS_SINCE_EPOCH
+      CBOREncoder.DateEncoding.DECIMAL_SECONDS_SINCE_EPOCH,
     );
   }
 
@@ -82,7 +96,7 @@ export class CBOREncoder implements MediaTypeEncoder {
       Reflect.hasMetadata(
         'jackson:defaultContextGroup:JsonSubTypes',
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        (value as any).constructor ?? {}
+        (value as any).constructor ?? {},
       )
     ) {
       type = [Object];
@@ -103,16 +117,16 @@ export class CBOREncoder implements MediaTypeEncoder {
       case CBOREncoder.DateEncoding.ISO8601:
         return new TaggedValue(
           DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(
-            value.atZone(ZoneId.UTC)
+            value.atZone(ZoneId.UTC),
           ),
-          isoDateTimeTag
+          isoDateTimeTag,
         );
       case CBOREncoder.DateEncoding.MILLISECONDS_SINCE_EPOCH:
         return new TaggedValue(value.toEpochMilli(), epochDateTimeTag);
       case CBOREncoder.DateEncoding.DECIMAL_SECONDS_SINCE_EPOCH:
         return new TaggedValue(
           secondsToNumber(value.epochSecond(), value.nano()),
-          epochDateTimeTag
+          epochDateTimeTag,
         );
     }
   };
@@ -126,18 +140,18 @@ export class CBOREncoder implements MediaTypeEncoder {
       case CBOREncoder.DateEncoding.ISO8601:
         return new TaggedValue(
           DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(value),
-          isoDateTimeTag
+          isoDateTimeTag,
         );
       case CBOREncoder.DateEncoding.MILLISECONDS_SINCE_EPOCH:
         return new TaggedValue(
           value.toInstant().toEpochMilli(),
-          epochDateTimeTag
+          epochDateTimeTag,
         );
       case CBOREncoder.DateEncoding.DECIMAL_SECONDS_SINCE_EPOCH:
         const instant = value.toInstant();
         return new TaggedValue(
           secondsToNumber(instant.epochSecond(), instant.nano()),
-          epochDateTimeTag
+          epochDateTimeTag,
         );
     }
   };
@@ -151,18 +165,18 @@ export class CBOREncoder implements MediaTypeEncoder {
       case CBOREncoder.DateEncoding.ISO8601:
         return new TaggedValue(
           DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(value),
-          isoDateTimeTag
+          isoDateTimeTag,
         );
       case CBOREncoder.DateEncoding.MILLISECONDS_SINCE_EPOCH:
         return new TaggedValue(
           value.toInstant().toEpochMilli(),
-          epochDateTimeTag
+          epochDateTimeTag,
         );
       case CBOREncoder.DateEncoding.DECIMAL_SECONDS_SINCE_EPOCH:
         const instant = value.toInstant();
         return new TaggedValue(
           secondsToNumber(instant.epochSecond(), instant.nano()),
-          epochDateTimeTag
+          epochDateTimeTag,
         );
     }
   };
@@ -189,7 +203,7 @@ export class CBOREncoder implements MediaTypeEncoder {
             this.dateEncoding ==
               CBOREncoder.DateEncoding.MILLISECONDS_SINCE_EPOCH
               ? value.get(ChronoField.MILLI_OF_SECOND)
-              : value.nano()
+              : value.nano(),
           ),
           value.offset().toString(),
         ];
@@ -216,7 +230,7 @@ export class CBOREncoder implements MediaTypeEncoder {
             this.dateEncoding ==
               CBOREncoder.DateEncoding.MILLISECONDS_SINCE_EPOCH
               ? value.get(ChronoField.MILLI_OF_SECOND)
-              : value.nano()
+              : value.nano(),
           ),
         ];
     }
@@ -252,7 +266,7 @@ export class CBOREncoder implements MediaTypeEncoder {
             this.dateEncoding ==
               CBOREncoder.DateEncoding.MILLISECONDS_SINCE_EPOCH
               ? value.get(ChronoField.MILLI_OF_SECOND)
-              : value.nano()
+              : value.nano(),
           ),
         ];
     }

package/src/media-type-codecs/cbor-tags.ts

@@ -1,3 +1,17 @@
+// Copyright 2020 Outfox, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 export const isoDateTimeTag = 0;
 export const epochDateTimeTag = 1;
 export const uriTag = 32;