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

package/src/media-type.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 class MediaType {
   type: MediaType.Type;
   tree: MediaType.Tree;
@@ -21,7 +35,7 @@ export class MediaType {
         obj[name.toLowerCase()] = value.toLowerCase();
         return obj;
       },
-      {} as Record<string, string>
+      {} as Record<string, string>,
     );
   }
 
@@ -47,7 +61,7 @@ export class MediaType {
 
   withParameter(
     parameter: MediaType.ParameterName | string,
-    value: string
+    value: string,
   ): MediaType {
     const parameters = Object.assign({}, this.parameters, {
       [parameter]: value,
@@ -181,28 +195,35 @@ export namespace MediaType {
     CharSet = 'charset',
   }
 
-  export function from(value?: string | null): MediaType | undefined;
+  export function from(value?: string | null): MediaType;
   export function from(
     value: string | null | undefined,
-    def: MediaType
+    def: MediaType,
   ): MediaType;
   export function from(
     value?: string | null,
-    def: MediaType | undefined = undefined
-  ): MediaType | undefined {
-    if (!value) {
+    def: MediaType | undefined = undefined,
+  ): MediaType {
+    const reqDef = () => {
+      if (!def) {
+        throw Error('Invalid media type');
+      }
       return def;
+    };
+
+    if (!value) {
+      return reqDef();
     }
 
     fullRegex.lastIndex = 0;
     const match = fullRegex.exec(value);
     if (match?.[0] != value) {
-      return def;
+      return reqDef();
     }
 
     const type = MediaType.Type.from(match[1]?.toLowerCase());
     if (!type) {
-      return def;
+      return reqDef();
     }
 
     const tree =
@@ -210,7 +231,7 @@ export namespace MediaType {
 
     const subtype = match[3]?.toLowerCase();
     if (!subtype) {
-      return def;
+      return reqDef();
     }
 
     const suffix = MediaType.Suffix.from(match[4]?.toLowerCase());
@@ -321,9 +342,21 @@ export namespace MediaType {
     suffix: Suffix.XML,
   });
 
-  export const ProblemJSON = new MediaType({
+  export const Problem = new MediaType({
     type: MediaType.Type.Application,
     subtype: 'problem',
     suffix: Suffix.JSON,
   });
+
+  export const JsonPatch = new MediaType({
+    type: MediaType.Type.Application,
+    subtype: 'json-patch',
+    suffix: Suffix.JSON,
+  });
+
+  export const MergePatch = new MediaType({
+    type: MediaType.Type.Application,
+    subtype: 'merge-patch',
+    suffix: Suffix.JSON,
+  });
 }

package/src/problem.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 { ResponseExample } from './fetch';
 import {
   JsonAnyGetter,
@@ -118,7 +132,7 @@ export class Problem extends Error implements Problem {
   static async fromResponse(response: Response): Promise<Problem> {
     const [bodyExcerpt, body] = await ResponseExample.bodyExcerpt(
       response,
-      256
+      256,
     );
 
     return new Problem({
@@ -129,9 +143,13 @@ export class Problem extends Error implements Problem {
         url: response.url,
       },
       response: {
-        type: response.type,
         headers: response.headers,
-        trailer: response.trailer,
+        ok: response.ok,
+        redirected: response.redirected,
+        status: response.status,
+        statusText: response.statusText,
+        type: response.type,
+        url: response.url,
         body,
         example: ResponseExample.build(response, bodyExcerpt),
       },

package/src/request-factory.ts

@@ -1,9 +1,24 @@
+// 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 { Observable } from 'rxjs';
 import { AnyType } from './any-type';
 import { ClassType, ConstructableClassType } from './class-type';
 import { MediaType } from './media-type';
 import { TextMediaTypeDecoder } from './media-type-codecs/media-type-decoder';
 import { Problem } from './problem';
+import { ResultResponse } from './result-response';
 import { URLTemplate } from './url-template';
 import { Logger } from './logger';
 
@@ -12,7 +27,7 @@ export interface RequestFactory {
 
   registerProblem(
     type: URL | string,
-    problemType: ConstructableClassType<Problem>
+    problemType: ConstructableClassType<Problem>,
   ): void;
 
   request(requestSpec: RequestSpec<unknown>): Observable<Request>;
@@ -21,22 +36,46 @@ export interface RequestFactory {
 
   response<B>(
     requestSpec: RequestSpec<B>,
-    dataExpected?: boolean
+    dataExpected?: boolean,
   ): Observable<Response>;
 
+  resultResponse<B, R>(
+    requestSpec: RequestSpec<B>,
+    resultType: [ClassType<R>],
+  ): Observable<ResultResponse<R>>;
+
+  resultResponse<B, R>(
+    requestSpec: RequestSpec<B>,
+    resultType: [ClassType<Array<unknown>>, ClassType<R>],
+  ): Observable<ResultResponse<Array<R>>>;
+
+  resultResponse<B, R>(
+    requestSpec: RequestSpec<B>,
+    resultType: [ClassType<Set<unknown>>, ClassType<R>],
+  ): Observable<ResultResponse<Set<R>>>;
+
+  resultResponse<B, R>(
+    requestSpec: RequestSpec<B>,
+    resultType: AnyType,
+  ): Observable<ResultResponse<R>>;
+
+  resultResponse<B>(
+    requestSpec: RequestSpec<B>,
+  ): Observable<ResultResponse<void>>;
+
   result<B, R>(
     requestSpec: RequestSpec<B>,
-    resultType: [ClassType<R>]
+    resultType: [ClassType<R>],
   ): Observable<R>;
 
   result<B, R>(
     requestSpec: RequestSpec<B>,
-    resultType: [ClassType<Array<unknown>>, ClassType<R>]
+    resultType: [ClassType<Array<unknown>>, ClassType<R>],
   ): Observable<Array<R>>;
 
   result<B, R>(
     requestSpec: RequestSpec<B>,
-    resultType: [ClassType<Set<unknown>>, ClassType<R>]
+    resultType: [ClassType<Set<unknown>>, ClassType<R>],
   ): Observable<Set<R>>;
 
   result<B, R>(requestSpec: RequestSpec<B>, resultType: AnyType): Observable<R>;
@@ -52,8 +91,8 @@ export interface RequestFactory {
       event: string | undefined,
       id: string | undefined,
       data: string,
-      logger?: Logger
-    ) => E | undefined
+      logger?: Logger,
+    ) => E | undefined,
   ): Observable<E>;
 }
 

package/src/result-response.ts

@@ -0,0 +1,18 @@
+// 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 ResultResponse<R> {
+  readonly result: R;
+  readonly response: Response;
+}

package/src/sunday-error.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 { ResponseExample } from './fetch';
 
 export class SundayError extends Error {
@@ -9,18 +23,18 @@ export class SundayError extends Error {
     public statusText: string,
     public headers: Headers,
     public body: unknown | undefined,
-    public responseExample: string
+    public responseExample: string,
   ) {
     super(message);
   }
 
   static async fromResponse(
     message: string,
-    response: Response
+    response: Response,
   ): Promise<SundayError> {
     const [bodyExcerpt, body] = await ResponseExample.bodyExcerpt(
       response,
-      256
+      256,
     );
 
     return new SundayError(
@@ -31,7 +45,7 @@ export class SundayError extends Error {
       response.statusText,
       response.headers,
       body,
-      ResponseExample.build(response, bodyExcerpt)
+      ResponseExample.build(response, bodyExcerpt),
     );
   }
 }

package/src/url-template.ts

@@ -1,9 +1,23 @@
+// 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 { URI } from 'uri-template-lite';
 
 export class URLTemplate {
   constructor(
     public template: string,
-    public parameters: Record<string, unknown> = {}
+    public parameters: Record<string, unknown> = {},
   ) {}
 
   complete(relativeTemplate: string, parameters: Record<string, unknown>): URL {

package/src/util/any.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 function unknownGet<T = unknown>(obj: unknown, key: string): T {
   return (obj as Record<string, unknown>)?.[key] as T;
 }

package/src/util/base64.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.
+
 const chars =
   'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';
 
@@ -17,7 +31,7 @@ export namespace Base64 {
   export function encodeSlice(
     buffer: ArrayBufferLike,
     offset: number,
-    length: number
+    length: number,
   ): string {
     const bytes = new Uint8Array(buffer, offset, length);
     const len = bytes.length;

package/src/util/error.ts

@@ -0,0 +1,28 @@
+// 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 function isError(value: unknown): value is Error {
+  return value instanceof Error;
+}
+
+export function errorToMessage(value: unknown, defMsg?: string): string {
+  return isError(value) ? value.message : defMsg ?? `${fmtMsg(value)}`;
+}
+
+function fmtMsg(value: unknown): string {
+  if (value instanceof Object) {
+    return JSON.stringify(value);
+  }
+  return `${value}`;
+}

package/src/util/hex.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 namespace Hex {
   export function decode(hex: string): ArrayBuffer {
     hex = hex.replace(/^0x/, '').replace(/\s/g, '');

package/src/util/rxjs.ts

@@ -1,16 +1,30 @@
+// 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 { catchError, from, Observable, throwError } from 'rxjs';
 import { ClassType } from '../class-type';
 import { Problem } from '../problem';
 
 export function nullifyNotFound<T>(): (
-  source: Observable<T>
+  source: Observable<T>,
 ) => Observable<T | null> {
   return nullifyResponse([404], []);
 }
 
 export function nullifyResponse<T>(
   statuses: number[],
-  problemTypes: ClassType<Problem>[]
+  problemTypes: ClassType<Problem>[],
 ): (source: Observable<T>) => Observable<T | null> {
   return function <T>(source: Observable<T>): Observable<T | null> {
     return source.pipe(
@@ -23,7 +37,7 @@ export function nullifyResponse<T>(
           return from([null]);
         }
         return throwError(error);
-      })
+      }),
     );
   };
 }

package/src/util/stream-rxjs.ts

@@ -1,7 +1,21 @@
+// 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 { Observable } from 'rxjs';
 
 export function fromStream(
-  stream: ReadableStream<Uint8Array>
+  stream: ReadableStream<Uint8Array>,
 ): Observable<ArrayBuffer> {
   return new Observable((subscriber) => {
     let reader: ReadableStreamDefaultReader | undefined;

package/src/util/temporal.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 function secondsToNumber(seconds: number, nanos: number): number {
   if (nanos == 0) {
     return seconds;