@outfoxx/sunday 1.1.0-beta.6 → 1.1.0-beta.7

package/src/problem.ts

@@ -1,171 +0,0 @@
-// 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;
-  status: number;
-  detail?: string;
-  instance?: URL;
-  [key: string]: unknown;
-}
-
-@JsonCreator({ mode: JsonCreatorMode.DELEGATING })
-export class Problem extends Error implements Problem {
-  @JsonProperty()
-  @JsonClassType({ type: () => [URL] })
-  public type: URL;
-
-  @JsonProperty()
-  @JsonClassType({ type: () => [String] })
-  public title: 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;
-    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,124 +0,0 @@
-// 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';
-
-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>;
-
-  response<B>(
-    requestSpec: RequestSpec<B>,
-    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>],
-  ): Observable<R>;
-
-  result<B, R>(
-    requestSpec: RequestSpec<B>,
-    resultType: [ClassType<Array<unknown>>, ClassType<R>],
-  ): Observable<Array<R>>;
-
-  result<B, R>(
-    requestSpec: RequestSpec<B>,
-    resultType: [ClassType<Set<unknown>>, ClassType<R>],
-  ): Observable<Set<R>>;
-
-  result<B, R>(requestSpec: RequestSpec<B>, resultType: AnyType): Observable<R>;
-
-  result<B>(requestSpec: RequestSpec<B>): Observable<void>;
-
-  eventSource(requestSpec: RequestSpec<void>): ExtEventSource;
-
-  eventStream<E>(
-    requestSpec: RequestSpec<void>,
-    decoder: (
-      decoder: TextMediaTypeDecoder,
-      event: string | undefined,
-      id: string | undefined,
-      data: string,
-      logger?: Logger,
-    ) => E | undefined,
-  ): Observable<E>;
-}
-
-export interface ExtEventSource extends EventSource {
-  connect(): void;
-}
-
-export type RequestMethod =
-  | 'GET'
-  | 'PUT'
-  | 'POST'
-  | 'PATCH'
-  | 'DELETE'
-  | 'HEAD'
-  | 'OPTIONS';
-
-export interface RequestSpec<B> {
-  method: RequestMethod;
-  pathTemplate: string;
-  pathParameters?: Record<string, unknown>;
-  queryParameters?: Record<string, unknown>;
-  body?: B;
-  bodyType?: AnyType;
-  contentTypes?: MediaType[];
-  acceptTypes?: MediaType[];
-  headers?: Record<string, unknown>;
-}
-
-export type RequestAdapter = (request: Request) => Observable<Request>;

package/src/sunday-error.ts

@@ -1,51 +0,0 @@
-// 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/util/base64.ts

@@ -1,91 +0,0 @@
-// 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+/';
-
-/* tslint:disable:no-bitwise */
-
-// Use a lookup table to find the index.
-const lookup = new Uint8Array(256);
-for (let i = 0; i < chars.length; i++) {
-  lookup[chars.charCodeAt(i)] = i;
-}
-
-export namespace Base64 {
-  export function encode(buffer: ArrayBufferLike): string {
-    return encodeSlice(buffer, 0, buffer.byteLength);
-  }
-
-  export function encodeSlice(
-    buffer: ArrayBufferLike,
-    offset: number,
-    length: number,
-  ): string {
-    const bytes = new Uint8Array(buffer, offset, length);
-    const len = bytes.length;
-    let base64 = '';
-
-    for (let i = 0; i < len; i += 3) {
-      base64 += chars[bytes[i] >> 2];
-      base64 += chars[((bytes[i] & 3) << 4) | (bytes[i + 1] >> 4)];
-      base64 += chars[((bytes[i + 1] & 15) << 2) | (bytes[i + 2] >> 6)];
-      base64 += chars[bytes[i + 2] & 63];
-    }
-
-    if (len % 3 === 2) {
-      base64 = base64.substring(0, base64.length - 1) + '=';
-    } else if (len % 3 === 1) {
-      base64 = base64.substring(0, base64.length - 2) + '==';
-    }
-
-    return base64;
-  }
-
-  export function decode(base64: string): ArrayBuffer {
-    base64 = base64.replace(/[ \n]+/g, '');
-
-    const length = base64.length;
-    let bufferLength = Math.floor(length * 0.75);
-    let i: number;
-    let p = 0;
-    let encoded1: number;
-    let encoded2: number;
-    let encoded3: number;
-    let encoded4: number;
-
-    if (base64[length - 1] === '=') {
-      bufferLength--;
-      if (base64[length - 2] === '=') {
-        bufferLength--;
-      }
-    }
-
-    const arrayBuffer = new ArrayBuffer(bufferLength);
-    const bytes = new Uint8Array(arrayBuffer);
-
-    for (i = 0; i < length; i += 4) {
-      encoded1 = lookup[base64.charCodeAt(i)];
-      encoded2 = lookup[base64.charCodeAt(i + 1)];
-      encoded3 = lookup[base64.charCodeAt(i + 2)];
-      encoded4 = lookup[base64.charCodeAt(i + 3)];
-
-      bytes[p++] = (encoded1 << 2) | (encoded2 >> 4);
-      bytes[p++] = ((encoded2 & 15) << 4) | (encoded3 >> 2);
-      bytes[p++] = ((encoded3 & 3) << 6) | (encoded4 & 63);
-    }
-
-    return arrayBuffer;
-  }
-}

package/src/util/error.ts

@@ -1,28 +0,0 @@
-// 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,30 +0,0 @@
-// 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 || values.length != hex.length / 2) {
-      throw Error(`Invalid hex string`);
-    }
-    return new Uint8Array(values.map((b) => parseInt(b, 16))).buffer;
-  }
-
-  export function encode(buffer: ArrayBuffer, separator = ''): string {
-    return Array.from(new Uint8Array(buffer))
-      .map((value) => value.toString(16).padStart(2, '0'))
-      .join(separator);
-  }
-}

package/src/util/rxjs.ts

@@ -1,43 +0,0 @@
-// 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) => {
-        const errorType = error.constructor as ClassType<Problem>;
-        if (
-          error instanceof Problem &&
-          (statuses.includes(error.status) || problemTypes.includes(errorType))
-        ) {
-          return from([null]);
-        }
-        return throwError(() => error);
-      }),
-    );
-  };
-}

package/src/util/stream-rxjs.ts

@@ -1,42 +0,0 @@
-// 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>,
-): Observable<ArrayBuffer> {
-  return new Observable((subscriber) => {
-    let reader: ReadableStreamDefaultReader | undefined;
-    (async function readLoop() {
-      try {
-        reader = stream.getReader();
-        while (true) {
-          const { done, value } = await reader.read();
-          if (value !== undefined) {
-            subscriber.next(value);
-          }
-
-          if (done) {
-            subscriber.complete();
-            return;
-          }
-        }
-      } catch (e) {
-        subscriber.error(e);
-      }
-    })();
-    return () => reader?.cancel();
-  });
-}