@outfoxx/sunday 1.0.9 → 1.1.0-alpha.11

package/src/problem.ts

@@ -1,25 +1,171 @@
-export interface Problem {
-  type: string;
+// 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,
+  JsonAnySetter,
+  JsonClassType,
+  JsonCreator,
+  JsonCreatorMode,
+  JsonIgnore,
+  JsonProperty,
+} from '@outfoxx/jackson-js';
+
+export interface ProblemSpec {
+  type: URL | string;
+  title: string;
   status: number;
+  detail?: string;
+  instance?: URL | string;
+  [key: string]: unknown;
+}
+
+export interface Problem {
+  type: URL;
   title: string;
-  detail: string;
-  instance: string;
+  status: number;
+  detail?: string;
+  instance?: URL;
   [key: string]: unknown;
 }
 
+@JsonCreator({ mode: JsonCreatorMode.DELEGATING })
 export class Problem extends Error implements Problem {
-  public type: string;
-  public status: number;
+  @JsonProperty()
+  @JsonClassType({ type: () => [URL] })
+  public type: URL;
+
+  @JsonProperty()
+  @JsonClassType({ type: () => [String] })
   public title: string;
-  public detail: string;
-  public instance: string;
 
-  constructor(json: Record<string, unknown>) {
-    super(`${json.status} ${json.type} - ${json.title}`);
-    this.type = json.type as string;
+  @JsonProperty()
+  @JsonClassType({ type: () => [Number] })
+  public status: number;
+
+  @JsonProperty()
+  @JsonClassType({ type: () => [String] })
+  public detail?: string;
+
+  @JsonProperty()
+  @JsonClassType({ type: () => [URL] })
+  public instance?: URL;
+
+  @JsonIgnore()
+  private _parameters?: Record<string, unknown>;
+
+  @JsonClassType({ type: () => [Object] })
+  @JsonAnyGetter()
+  public get parameters(): Record<string, unknown> | undefined {
+    return this._parameters;
+  }
+
+  @JsonAnySetter()
+  private setParameter(key: string, value: unknown) {
+    this._parameters = this._parameters ?? {};
+    this._parameters[key] = value;
+  }
+
+  constructor(spec: ProblemSpec) {
+    super(`${spec.status.toString()} ${spec.type} - ${spec.title}`);
+
+    const src = spec as unknown as Record<string, unknown>;
+
+    const json = Object.assign({}, src);
+
+    this.type = Problem.parseURL(json.type) ?? new URL('about:blank');
+    delete json.type;
+
     this.status = json.status as number;
+    delete json.status;
+
     this.title = json.title as string;
+    delete json.title;
+
     this.detail = json.detail as string;
-    this.instance = json.instance as string;
+    delete json.detail;
+
+    this.instance = Problem.parseURL(json.instance);
+    delete json.instance;
+
+    if (Object.keys(json).length != 0) {
+      this._parameters = json;
+    }
+  }
+
+  toString(): string {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const self = this as Record<string, any>;
+    const url = self.request ? self.request?.url : undefined;
+    const response = self.response?.example;
+    return JSON.stringify({
+      type: this.type,
+      status: this.status,
+      title: this.title,
+      detail: this.detail,
+      instance: this.instance,
+      url,
+      response,
+    });
+  }
+
+  static fromStatus(status: number, title: string): Problem {
+    return new Problem({
+      type: 'about:blank',
+      title,
+      status,
+    });
+  }
+
+  static async fromResponse(response: Response): Promise<Problem> {
+    const [bodyExcerpt, body] = await ResponseExample.bodyExcerpt(
+      response,
+      256
+    );
+
+    return new Problem({
+      type: 'about:blank',
+      title: response.statusText,
+      status: response.status,
+      request: {
+        url: response.url,
+      },
+      response: {
+        headers: response.headers,
+        ok: response.ok,
+        redirected: response.redirected,
+        status: response.status,
+        statusText: response.statusText,
+        type: response.type,
+        url: response.url,
+        body,
+        example: ResponseExample.build(response, bodyExcerpt),
+      },
+    });
+  }
+
+  private static parseURL(value: unknown | undefined | null): URL | undefined {
+    if (value == null) {
+      return undefined;
+    }
+    if (value instanceof URL) {
+      return value;
+    }
+    if (typeof value == 'string') {
+      return new URL(value);
+    }
+    return new URL(`${value}`);
   }
 }

package/src/request-factory.ts

@@ -1,13 +1,34 @@
-import { ClassList } from '@outfoxx/jackson-js/dist/@types';
+// 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 } from './class-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 { URLTemplate } from './url-template';
+import { Logger } from './logger';
 
 export interface RequestFactory {
   readonly baseUrl: URLTemplate;
 
+  registerProblem(
+    type: URL | string,
+    problemType: ConstructableClassType<Problem>
+  ): void;
+
   request(requestSpec: RequestSpec<unknown>): Observable<Request>;
 
   response(request: Request, dataExpected?: boolean): Observable<Response>;
@@ -36,11 +57,17 @@ export interface RequestFactory {
 
   result<B>(requestSpec: RequestSpec<B>): Observable<void>;
 
-  events(requestSpec: RequestSpec<void>): ExtEventSource;
+  eventSource(requestSpec: RequestSpec<void>): ExtEventSource;
 
-  events<E>(
+  eventStream<E>(
     requestSpec: RequestSpec<void>,
-    eventTypes: EventTypes<E>
+    decoder: (
+      decoder: TextMediaTypeDecoder,
+      event: string | undefined,
+      id: string | undefined,
+      data: string,
+      logger?: Logger
+    ) => E | undefined
   ): Observable<E>;
 }
 
@@ -64,13 +91,9 @@ export interface RequestSpec<B> {
   queryParameters?: Record<string, unknown>;
   body?: B;
   bodyType?: AnyType;
-  contentTypes?: (MediaType | string)[];
-  acceptTypes?: (MediaType | string)[];
-  headers?: HeadersInit;
-}
-
-export interface EventTypes<E> {
-  [key: string]: ClassList<ClassType<E>>;
+  contentTypes?: MediaType[];
+  acceptTypes?: MediaType[];
+  headers?: Record<string, unknown>;
 }
 
 export type RequestAdapter = (request: Request) => Observable<Request>;

package/src/sunday-error.ts

@@ -0,0 +1,51 @@
+// 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 {
+  constructor(
+    message: string,
+    public url: string,
+    public httpVersion: string,
+    public status: number,
+    public statusText: string,
+    public headers: Headers,
+    public body: unknown | undefined,
+    public responseExample: string
+  ) {
+    super(message);
+  }
+
+  static async fromResponse(
+    message: string,
+    response: Response
+  ): Promise<SundayError> {
+    const [bodyExcerpt, body] = await ResponseExample.bodyExcerpt(
+      response,
+      256
+    );
+
+    return new SundayError(
+      message,
+      response.url,
+      '?.?',
+      response.status,
+      response.statusText,
+      response.headers,
+      body,
+      ResponseExample.build(response, bodyExcerpt)
+    );
+  }
+}

package/src/url-template.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 { URI } from 'uri-template-lite';
 
 export class URLTemplate {

package/src/util/any.ts

@@ -0,0 +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.
+
+export function unknownGet<T = unknown>(obj: unknown, key: string): T {
+  return (obj as Record<string, unknown>)?.[key] as T;
+}
+
+export function unknownSet<T>(obj: unknown, key: string, value: T): void {
+  if (obj == null) {
+    return;
+  }
+  (obj as Record<string, unknown>)[key] = value;
+}

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+/';
 

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,8 +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.
+
 export namespace Hex {
   export function decode(hex: string): ArrayBuffer {
+    hex = hex.replace(/^0x/, '').replace(/\s/g, '');
     const values = hex.match(/[\da-f]{2}/gi);
-    if (!values) {
-      throw Error('Invalid hex string');
+    if (!values || values.length != hex.length / 2) {
+      throw Error(`Invalid hex string`);
     }
     return new Uint8Array(values.map((b) => parseInt(b, 16))).buffer;
   }

package/src/util/rxjs.ts

@@ -1,17 +1,42 @@
-import { from, Observable, throwError } from 'rxjs';
-import { catchError } from 'rxjs/operators';
+// 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>
 ) => Observable<T | null> {
+  return nullifyResponse([404], []);
+}
+
+export function nullifyResponse<T>(
+  statuses: number[],
+  problemTypes: ClassType<Problem>[]
+): (source: Observable<T>) => Observable<T | null> {
   return function <T>(source: Observable<T>): Observable<T | null> {
     return source.pipe(
       catchError((error) => {
-        if (!(error instanceof Problem) || error.status !== 404) {
-          return throwError(error);
+        const errorType = error.constructor as ClassType<Problem>;
+        if (
+          error instanceof Problem &&
+          (statuses.includes(error.status) || problemTypes.includes(errorType))
+        ) {
+          return from([null]);
         }
-        return from([null]);
+        return throwError(error);
       })
     );
   };

package/src/util/stream-rxjs.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 { Observable } from 'rxjs';
 
 export function fromStream(

package/src/util/temporal.ts

@@ -0,0 +1,32 @@
+// 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;
+  }
+  const nanoStr = nanos.toString();
+  return parseFloat(`${seconds}.${'0'.repeat(9 - nanoStr.length)}${nanos}`);
+}
+
+export function encodeSeconds(seconds: number, fraction: number): unknown[] {
+  const result = [];
+  if (seconds != 0 || fraction != 0) {
+    result.push(seconds);
+    if (fraction != 0) {
+      result.push(fraction);
+    }
+  }
+  return result;
+}

package/dist/binary-decoder.js

@@ -1,16 +0,0 @@
-export class BinaryDecoder {
-    async decode(response, type) {
-        const arrayBuffer = await response.arrayBuffer();
-        if (type[0] === ArrayBuffer) {
-            return arrayBuffer;
-        }
-        else if (type[0] === Uint8Array ||
-            type[0] === Int8Array ||
-            type[0] === DataView) {
-            return new type[0](arrayBuffer);
-        }
-        throw Error('Invalid value, expected ArrayBuffer, (Int|Uint)Array or DataView');
-    }
-}
-BinaryDecoder.default = new BinaryDecoder();
-//# sourceMappingURL=binary-decoder.js.map

package/dist/binary-decoder.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"binary-decoder.js","sourceRoot":"","sources":["../src/binary-decoder.ts"],"names":[],"mappings":"AAGA,MAAM,OAAO,aAAa;IAGxB,KAAK,CAAC,MAAM,CAAI,QAAkB,EAAE,IAAa;QAC/C,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC;QAEjD,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,WAAW,EAAE;YAC3B,OAAQ,WAA4B,CAAC;SACtC;aAAM,IACL,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU;YACtB,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS;YACrB,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EACpB;YACA,OAAO,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CAAM,CAAC;SACtC;QAED,MAAM,KAAK,CACT,kEAAkE,CACnE,CAAC;IACJ,CAAC;;AAlBM,qBAAO,GAAG,IAAI,aAAa,EAAE,CAAC"}

package/dist/binary-encoder.js

@@ -1,13 +0,0 @@
-export class BinaryEncoder {
-    encode(value) {
-        if (!ArrayBuffer.isView(value) &&
-            !(value instanceof ArrayBuffer) &&
-            !(value instanceof Blob) &&
-            !(value instanceof ReadableStream)) {
-            throw Error('Invalid value, expected BufferSource, Blob or ReadableStream');
-        }
-        return value;
-    }
-}
-BinaryEncoder.default = new BinaryEncoder();
-//# sourceMappingURL=binary-encoder.js.map

package/dist/binary-encoder.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"binary-encoder.js","sourceRoot":"","sources":["../src/binary-encoder.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,aAAa;IAGxB,MAAM,CAAC,KAAc;QACnB,IACE,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC;YAC1B,CAAC,CAAC,KAAK,YAAY,WAAW,CAAC;YAC/B,CAAC,CAAC,KAAK,YAAY,IAAI,CAAC;YACxB,CAAC,CAAC,KAAK,YAAY,cAAc,CAAC,EAClC;YACA,MAAM,KAAK,CACT,8DAA8D,CAC/D,CAAC;SACH;QACD,OAAO,KAAK,CAAC;IACf,CAAC;;AAdM,qBAAO,GAAG,IAAI,aAAa,EAAE,CAAC"}

package/dist/cbor-decoder.d.ts

@@ -1,15 +0,0 @@
-import { AnyType } from './any-type';
-import { MediaTypeDecoder } from './media-type-decoder';
-export declare class CBORDecoder implements MediaTypeDecoder {
-    static get default(): CBORDecoder;
-    private readonly customDeserializers;
-    private readonly parser;
-    constructor();
-    decode<T>(response: Response, type: AnyType): Promise<T>;
-    decodeData<T>(buffer: ArrayBuffer, type: AnyType): T;
-    private static untag;
-    private dateTimeDeserializer;
-    private dateDeserializer;
-    private urlDeserializer;
-    private arrayBufferDeserializer;
-}