@everyonesoftware/common 2.0.0 → 3.0.0

package/sources/recreationDotGovClient.ts

@@ -1,259 +1,259 @@
-import { PromiseAsyncResult } from "./promiseAsyncResult";
-import { DateTime } from "./dateTime";
-import { HttpClient } from "./httpClient";
-import { HttpIncomingResponse } from "./httpIncomingResponse";
-import { HttpOutgoingRequest } from "./httpOutgoingRequest";
-import { Iterable } from "./iterable";
-import { List } from "./list";
-import { PreCondition } from "./preCondition";
-import { AsyncResult } from "./asyncResult";
-
-export interface RecreationDotGovDivisionDayAvailability
-{
-    readonly date: DateTime;
-
-    readonly walkup: boolean;
-
-    readonly reservationsRemaining: number;
-
-    readonly totalSpots: number;
-}
-
-export interface RecreationDotGovDivisionAvailabilityJson
-{
-    readonly bools: { [date: string]: boolean };
-
-    readonly rules: {
-        readonly name: string;
-        readonly value: number;
-    }[];
-
-    readonly quota_type_maps: {
-        readonly ConstantQuotaUsageDaily?: {
-            [date: string]: {
-                readonly is_hidden: boolean;
-                readonly remaining: number;
-                readonly season_type: string;
-                readonly show_walkup: boolean;
-                readonly total: number;
-            };
-        };
-        readonly QuotaUsageByMemberDaily?: {
-            [date: string]: {
-                readonly is_hidden: boolean;
-                readonly remaining: number;
-                readonly season_type: string;
-                readonly show_walkup: boolean;
-                readonly total: number;
-            };
-        };
-    };
-}
-
-export class RecreationDotGovDivisionAvailability
-{
-    public readonly json: RecreationDotGovDivisionAvailabilityJson;
-
-    public readonly minimumGroupSize?: number;
-    public readonly maximumGroupSize?: number;
-    public readonly dayAvailabilities: Iterable<RecreationDotGovDivisionDayAvailability>;
-
-    private constructor(json: RecreationDotGovDivisionAvailabilityJson)
-    {
-        PreCondition.assertNotUndefinedAndNotNull(json, "json");
-
-        this.json = json;
-
-        const minGroupSize: string = "MinGroupSize".toLowerCase();
-        const maxGroupSize: string = "MaxGroupSize".toLowerCase();
-        for (const rule of json.rules)
-        {
-            switch (rule.name.toLowerCase())
-            {
-                case minGroupSize:
-                    this.minimumGroupSize = rule.value;
-                    break;
-
-                case maxGroupSize:
-                    this.maximumGroupSize = rule.value;
-                    break;
-            }
-        }
-
-        const dayAvailabilities = List.create<RecreationDotGovDivisionDayAvailability>();
-        const quotaUsageByMemberDaily = json.quota_type_maps?.QuotaUsageByMemberDaily;
-        if (quotaUsageByMemberDaily)
-        {
-            for (const quotaUsage of Object.entries(quotaUsageByMemberDaily))
-            {
-                const dateString: string = quotaUsage[0];
-
-                const usageData = quotaUsage[1];
-
-                let walkup: boolean = false;
-                let reservationsRemaining: number = 0;
-                const boolsEntry: boolean = json.bools[dateString];
-                if (boolsEntry)
-                {
-                    walkup = usageData.show_walkup;
-                    reservationsRemaining = usageData.remaining;
-                }
-
-                dayAvailabilities.add({
-                    date: DateTime.parse(dateString),
-                    totalSpots: usageData.total,
-                    walkup,
-                    reservationsRemaining,
-                });
-            }
-        }
-        this.dayAvailabilities = dayAvailabilities;
-    }
-
-    public static create(json: RecreationDotGovDivisionAvailabilityJson): RecreationDotGovDivisionAvailability
-    {
-        return new RecreationDotGovDivisionAvailability(json);
-    }
-}
-
-interface RecreationDotGovPayloadResponse<T>
-{
-    readonly payload: T;
-}
-
-export interface RecreationDotGovDivisionJson
-{
-    readonly id: string;
-
-    readonly name: string;
-
-    readonly type: string;
-
-    readonly district: string;
-}
-
-export interface RecreationDotGovPermitItineraryJson
-{
-    readonly id: string;
-
-    readonly name: string;
-
-    readonly divisions: { [divisionId: number]: RecreationDotGovDivisionJson };
-}
-
-export class RecreationDotGovError extends Error
-{
-    public constructor(message: string)
-    {
-        super(message);
-    }
-}
-
-export interface RecreationDotGovErrorResponse
-{
-    readonly error: string;
-}
-
-export class RecreationDotGovClient implements HttpClient
-{
-    private readonly httpClient: HttpClient;
-
-    private constructor(httpClient: HttpClient)
-    {
-        PreCondition.assertNotUndefinedAndNotNull(httpClient, "httpClient");
-
-        this.httpClient = httpClient;
-    }
-
-    public static create(httpClient: HttpClient): RecreationDotGovClient
-    {
-        return new RecreationDotGovClient(httpClient);
-    }
-
-    public sendRequest(request: HttpOutgoingRequest): AsyncResult<HttpIncomingResponse>
-    {
-        return this.httpClient.sendRequest(request);
-    }
-
-    public sendGetRequest(url: string): AsyncResult<HttpIncomingResponse>
-    {
-        return HttpClient.sendGetRequest(this, url);
-    }
-
-    public getPermitItinerary(permitItineraryId: string): PromiseAsyncResult<RecreationDotGovPermitItineraryJson>
-    {
-        PreCondition.assertNotEmpty(permitItineraryId, "permitItineraryId");
-
-        return PromiseAsyncResult.create(async () =>
-        {
-            const response: HttpIncomingResponse = await this.sendGetRequest(`https://www.recreation.gov/api/permitcontent/${permitItineraryId}`);
-
-            const responseBody: string = await response.getBody();
-
-            const statusCode: number = response.getStatusCode();
-            if (statusCode < 200 || 300 <= statusCode)
-            {
-                const responseBodyJson: RecreationDotGovErrorResponse = JSON.parse(responseBody);
-                const errorMessage: string = responseBodyJson.error;
-                switch (errorMessage.toLowerCase())
-                {
-                    case "permit not found":
-                        throw new RecreationDotGovError(`No permit itinerary found for id: ${JSON.stringify(permitItineraryId)}`);
-                        
-                    default:
-                        throw new RecreationDotGovError(`Unrecognized error: ${JSON.stringify(errorMessage)}`);
-                }
-            }
-
-            const responseBodyJson: RecreationDotGovPayloadResponse<RecreationDotGovPermitItineraryJson> = JSON.parse(responseBody);
-            return responseBodyJson.payload;
-        });
-    }
-
-    public getDivisionAvailability(permitItineraryId: string, divisionId: string, month: number, year: number, earlyAccessPermitLotteryId?: string): PromiseAsyncResult<RecreationDotGovDivisionAvailability>
-    {
-        PreCondition.assertNotEmpty(permitItineraryId, "permitItineraryId");
-        PreCondition.assertNotEmpty(divisionId, "divisionId");
-        PreCondition.assertBetween(1, month, 12, "month");
-
-        return PromiseAsyncResult.create(async () =>
-        {
-            const url: string = earlyAccessPermitLotteryId
-                ? `https://www.recreation.gov/api/permititinerary/${permitItineraryId}/division/${divisionId}/eapavailability/month/${earlyAccessPermitLotteryId}?month=${month}&year=${year}`
-                : `https://www.recreation.gov/api/permititinerary/${permitItineraryId}/division/${divisionId}/availability/month?month=${month}&year=${year}`
-            const response: HttpIncomingResponse = await this.sendGetRequest(url);
-
-            let responseBody: string = await response.getBody();
-
-            const statusCode: number = response.getStatusCode();
-            if (statusCode < 200 || 300 <= statusCode)
-            {
-                const responseBodyJson: RecreationDotGovErrorResponse = JSON.parse(responseBody) as RecreationDotGovErrorResponse;
-                const errorMessage: string = responseBodyJson.error;
-                switch (errorMessage.toLowerCase())
-                {
-                    case "invalid permit id":
-                        throw new RecreationDotGovError(`No permit itinerary found for id: ${JSON.stringify(permitItineraryId)}`);
-
-                    case "request year is missing or invalid":
-                        // Ignore this error and just return an empty availability.
-                        const emptyResponseBody: RecreationDotGovPayloadResponse<RecreationDotGovDivisionAvailabilityJson> = {
-                            payload: {
-                                bools: {},
-                                rules: [],
-                                quota_type_maps: {},
-                            },
-                        };
-                        responseBody = JSON.stringify(emptyResponseBody);
-                        break;
-                        
-                    default:
-                        throw new RecreationDotGovError(`Unrecognized error: ${JSON.stringify(errorMessage)}`);
-                }
-            }
-
-            const responseBodyJson: RecreationDotGovPayloadResponse<RecreationDotGovDivisionAvailabilityJson> = JSON.parse(responseBody);
-            return RecreationDotGovDivisionAvailability.create(responseBodyJson.payload);
-        });
-    }
+import { PromiseAsyncResult } from "./promiseAsyncResult";
+import { DateTime } from "./dateTime";
+import { HttpClient } from "./httpClient";
+import { HttpIncomingResponse } from "./httpIncomingResponse";
+import { HttpOutgoingRequest } from "./httpOutgoingRequest";
+import { Iterable } from "./iterable";
+import { List } from "./list";
+import { PreCondition } from "./preCondition";
+import { AsyncResult } from "./asyncResult";
+
+export interface RecreationDotGovDivisionDayAvailability
+{
+    readonly date: DateTime;
+
+    readonly walkup: boolean;
+
+    readonly reservationsRemaining: number;
+
+    readonly totalSpots: number;
+}
+
+export interface RecreationDotGovDivisionAvailabilityJson
+{
+    readonly bools: { [date: string]: boolean };
+
+    readonly rules: {
+        readonly name: string;
+        readonly value: number;
+    }[];
+
+    readonly quota_type_maps: {
+        readonly ConstantQuotaUsageDaily?: {
+            [date: string]: {
+                readonly is_hidden: boolean;
+                readonly remaining: number;
+                readonly season_type: string;
+                readonly show_walkup: boolean;
+                readonly total: number;
+            };
+        };
+        readonly QuotaUsageByMemberDaily?: {
+            [date: string]: {
+                readonly is_hidden: boolean;
+                readonly remaining: number;
+                readonly season_type: string;
+                readonly show_walkup: boolean;
+                readonly total: number;
+            };
+        };
+    };
+}
+
+export class RecreationDotGovDivisionAvailability
+{
+    public readonly json: RecreationDotGovDivisionAvailabilityJson;
+
+    public readonly minimumGroupSize?: number;
+    public readonly maximumGroupSize?: number;
+    public readonly dayAvailabilities: Iterable<RecreationDotGovDivisionDayAvailability>;
+
+    private constructor(json: RecreationDotGovDivisionAvailabilityJson)
+    {
+        PreCondition.assertNotUndefinedAndNotNull(json, "json");
+
+        this.json = json;
+
+        const minGroupSize: string = "MinGroupSize".toLowerCase();
+        const maxGroupSize: string = "MaxGroupSize".toLowerCase();
+        for (const rule of json.rules)
+        {
+            switch (rule.name.toLowerCase())
+            {
+                case minGroupSize:
+                    this.minimumGroupSize = rule.value;
+                    break;
+
+                case maxGroupSize:
+                    this.maximumGroupSize = rule.value;
+                    break;
+            }
+        }
+
+        const dayAvailabilities = List.create<RecreationDotGovDivisionDayAvailability>();
+        const quotaUsageByMemberDaily = json.quota_type_maps?.QuotaUsageByMemberDaily;
+        if (quotaUsageByMemberDaily)
+        {
+            for (const quotaUsage of Object.entries(quotaUsageByMemberDaily))
+            {
+                const dateString: string = quotaUsage[0];
+
+                const usageData = quotaUsage[1];
+
+                let walkup: boolean = false;
+                let reservationsRemaining: number = 0;
+                const boolsEntry: boolean = json.bools[dateString];
+                if (boolsEntry)
+                {
+                    walkup = usageData.show_walkup;
+                    reservationsRemaining = usageData.remaining;
+                }
+
+                dayAvailabilities.add({
+                    date: DateTime.parse(dateString),
+                    totalSpots: usageData.total,
+                    walkup,
+                    reservationsRemaining,
+                });
+            }
+        }
+        this.dayAvailabilities = dayAvailabilities;
+    }
+
+    public static create(json: RecreationDotGovDivisionAvailabilityJson): RecreationDotGovDivisionAvailability
+    {
+        return new RecreationDotGovDivisionAvailability(json);
+    }
+}
+
+interface RecreationDotGovPayloadResponse<T>
+{
+    readonly payload: T;
+}
+
+export interface RecreationDotGovDivisionJson
+{
+    readonly id: string;
+
+    readonly name: string;
+
+    readonly type: string;
+
+    readonly district: string;
+}
+
+export interface RecreationDotGovPermitItineraryJson
+{
+    readonly id: string;
+
+    readonly name: string;
+
+    readonly divisions: { [divisionId: number]: RecreationDotGovDivisionJson };
+}
+
+export class RecreationDotGovError extends Error
+{
+    public constructor(message: string)
+    {
+        super(message);
+    }
+}
+
+export interface RecreationDotGovErrorResponse
+{
+    readonly error: string;
+}
+
+export class RecreationDotGovClient implements HttpClient
+{
+    private readonly httpClient: HttpClient;
+
+    private constructor(httpClient: HttpClient)
+    {
+        PreCondition.assertNotUndefinedAndNotNull(httpClient, "httpClient");
+
+        this.httpClient = httpClient;
+    }
+
+    public static create(httpClient: HttpClient): RecreationDotGovClient
+    {
+        return new RecreationDotGovClient(httpClient);
+    }
+
+    public sendRequest(request: HttpOutgoingRequest): AsyncResult<HttpIncomingResponse>
+    {
+        return this.httpClient.sendRequest(request);
+    }
+
+    public sendGetRequest(url: string): AsyncResult<HttpIncomingResponse>
+    {
+        return HttpClient.sendGetRequest(this, url);
+    }
+
+    public getPermitItinerary(permitItineraryId: string): PromiseAsyncResult<RecreationDotGovPermitItineraryJson>
+    {
+        PreCondition.assertNotEmpty(permitItineraryId, "permitItineraryId");
+
+        return PromiseAsyncResult.create(async () =>
+        {
+            const response: HttpIncomingResponse = await this.sendGetRequest(`https://www.recreation.gov/api/permitcontent/${permitItineraryId}`);
+
+            const responseBody: string = await response.getBody();
+
+            const statusCode: number = response.getStatusCode();
+            if (statusCode < 200 || 300 <= statusCode)
+            {
+                const responseBodyJson: RecreationDotGovErrorResponse = JSON.parse(responseBody);
+                const errorMessage: string = responseBodyJson.error;
+                switch (errorMessage.toLowerCase())
+                {
+                    case "permit not found":
+                        throw new RecreationDotGovError(`No permit itinerary found for id: ${JSON.stringify(permitItineraryId)}`);
+                        
+                    default:
+                        throw new RecreationDotGovError(`Unrecognized error: ${JSON.stringify(errorMessage)}`);
+                }
+            }
+
+            const responseBodyJson: RecreationDotGovPayloadResponse<RecreationDotGovPermitItineraryJson> = JSON.parse(responseBody);
+            return responseBodyJson.payload;
+        });
+    }
+
+    public getDivisionAvailability(permitItineraryId: string, divisionId: string, month: number, year: number, earlyAccessPermitLotteryId?: string): PromiseAsyncResult<RecreationDotGovDivisionAvailability>
+    {
+        PreCondition.assertNotEmpty(permitItineraryId, "permitItineraryId");
+        PreCondition.assertNotEmpty(divisionId, "divisionId");
+        PreCondition.assertBetween(1, month, 12, "month");
+
+        return PromiseAsyncResult.create(async () =>
+        {
+            const url: string = earlyAccessPermitLotteryId
+                ? `https://www.recreation.gov/api/permititinerary/${permitItineraryId}/division/${divisionId}/eapavailability/month/${earlyAccessPermitLotteryId}?month=${month}&year=${year}`
+                : `https://www.recreation.gov/api/permititinerary/${permitItineraryId}/division/${divisionId}/availability/month?month=${month}&year=${year}`
+            const response: HttpIncomingResponse = await this.sendGetRequest(url);
+
+            let responseBody: string = await response.getBody();
+
+            const statusCode: number = response.getStatusCode();
+            if (statusCode < 200 || 300 <= statusCode)
+            {
+                const responseBodyJson: RecreationDotGovErrorResponse = JSON.parse(responseBody) as RecreationDotGovErrorResponse;
+                const errorMessage: string = responseBodyJson.error;
+                switch (errorMessage.toLowerCase())
+                {
+                    case "invalid permit id":
+                        throw new RecreationDotGovError(`No permit itinerary found for id: ${JSON.stringify(permitItineraryId)}`);
+
+                    case "request year is missing or invalid":
+                        // Ignore this error and just return an empty availability.
+                        const emptyResponseBody: RecreationDotGovPayloadResponse<RecreationDotGovDivisionAvailabilityJson> = {
+                            payload: {
+                                bools: {},
+                                rules: [],
+                                quota_type_maps: {},
+                            },
+                        };
+                        responseBody = JSON.stringify(emptyResponseBody);
+                        break;
+                        
+                    default:
+                        throw new RecreationDotGovError(`Unrecognized error: ${JSON.stringify(errorMessage)}`);
+                }
+            }
+
+            const responseBodyJson: RecreationDotGovPayloadResponse<RecreationDotGovDivisionAvailabilityJson> = JSON.parse(responseBody);
+            return RecreationDotGovDivisionAvailability.create(responseBodyJson.payload);
+        });
+    }
 }

package/sources/searchControl.ts

@@ -1,42 +1,42 @@
-import { JavascriptIterable } from "./javascript";
-
-/**
- * An object that can be used to implement a search algorithm.
- */
-export abstract class SearchControl<TVisit,TResult>
-{
-    /**
-     * Add the provided value to the to-visit list.
-     * @param value The value to add to the to-visit list.
-     */
-    public abstract addToVisit(value: TVisit): void;
-
-    /**
-     * Add the provided values to the to-visit list.
-     * @param values The values to add to the to-visit list.
-     */
-    public abstract addAllToVisit(values: JavascriptIterable<TVisit>): void;
-
-    /**
-     * Get whether the provided value has already been visited.
-     * @param value The value to check.
-     */
-    public abstract hasVisited(value: TVisit): boolean;
-
-    /**
-     * Add the provided value to the list of values to be returned.
-     * @param value The value to add.
-     */
-    public abstract addResult(value: TResult): void;
-
-    /**
-     * Add the provided values to the list of values to be returned.
-     * @param values The values to add.
-     */
-    public abstract addResults(values: JavascriptIterable<TResult>): void;
-
-    /**
-     * Immediately stop the search.
-     */
-    public abstract break(): never;
+import { JavascriptIterable } from "./javascript";
+
+/**
+ * An object that can be used to implement a search algorithm.
+ */
+export abstract class SearchControl<TVisit,TResult>
+{
+    /**
+     * Add the provided value to the to-visit list.
+     * @param value The value to add to the to-visit list.
+     */
+    public abstract addToVisit(value: TVisit): void;
+
+    /**
+     * Add the provided values to the to-visit list.
+     * @param values The values to add to the to-visit list.
+     */
+    public abstract addAllToVisit(values: JavascriptIterable<TVisit>): void;
+
+    /**
+     * Get whether the provided value has already been visited.
+     * @param value The value to check.
+     */
+    public abstract hasVisited(value: TVisit): boolean;
+
+    /**
+     * Add the provided value to the list of values to be returned.
+     * @param value The value to add.
+     */
+    public abstract addResult(value: TResult): void;
+
+    /**
+     * Add the provided values to the list of values to be returned.
+     * @param values The values to add.
+     */
+    public abstract addResults(values: JavascriptIterable<TResult>): void;
+
+    /**
+     * Immediately stop the search.
+     */
+    public abstract break(): never;
 }