Preferred portal refresh

.eslintrc.json

@@ -16,6 +16,18 @@
     "@typescript-eslint/no-unused-vars": ["warn", { "argsIgnorePattern": "^_", "varsIgnorePattern": "^_" }],
 
     "jsdoc/require-description": 1,
+    "jsdoc/require-jsdoc": [
+      "error",
+      {
+        "require": {
+          "FunctionDeclaration": true,
+          "MethodDefinition": true,
+          "ClassDeclaration": true,
+          "ArrowFunctionExpression": false,
+          "FunctionExpression": false
+        }
+      }
+    ],
     "jsdoc/require-throws": 1,
 
     "jsdoc/require-param-type": 0,

src/client.test.ts

@@ -1,12 +1,12 @@
 import axios from "axios";
 import MockAdapter from "axios-mock-adapter";
 
-import { combineStrings } from "../utils/testing";
 import { SkynetClient } from "./index";
 import { buildRequestUrl } from "./request";
-import { defaultSkynetPortalUrl } from "./utils/url";
+import { combineStrings } from "../utils/testing";
+import { DEFAULT_SKYNET_PORTAL_URL } from "./utils/url";
 
-const portalUrl = defaultSkynetPortalUrl;
+const portalUrl = DEFAULT_SKYNET_PORTAL_URL;
 const client = new SkynetClient(portalUrl);
 let mock: MockAdapter;
 
@@ -101,7 +101,7 @@ describe("buildRequestUrl", () => {
   describe("localhost inputs", () => {
     // `localhost` without a protocol prefix is not in this list because
     // `buildRequestUrl` always ensures a prefix protocol for consistency.
-    const validExpectedLocalhosts = combineStrings(["https://", "http://"], ["localhost"], ["", "/"]);
+    const validExpectedLocalhosts = combineStrings(["https:", "http:"], ["", "//"], ["localhost"], ["", "/"]);
     const localhostUrls = combineStrings(["", "https://", "https:", "http://", "http:"], ["localhost"], ["", "/"]);
 
     it.each(localhostUrls)("should correctly handle input '%s'", async (localhostUrl) => {

src/client.ts

@@ -331,6 +331,11 @@ export class SkynetClient {
   // Private Methods
   // ===============
 
+  /**
+   * Make a request to resolve the provided `initialPortalUrl`.
+   *
+   * @returns - The portal URL.
+   */
   protected async resolvePortalUrl(): Promise<string> {
     const response = await this.executeRequest({
       ...this.customOptions,

src/mysky/connector.ts

@@ -31,7 +31,20 @@ export const DEFAULT_CONNECTOR_OPTIONS = {
   handshakeAttemptsInterval: defaultHandshakeAttemptsInterval,
 };
 
+/**
+ * The object that connects to a child iframe and keeps track of information
+ * about it.
+ */
 export class Connector {
+  /**
+   * Creates a `Connector`.
+   *
+   * @param url - The iframe URL.
+   * @param client - The Skynet Client.
+   * @param childFrame - The iframe handle.
+   * @param connection - The postmessage handshake connection.
+   * @param options - The custom options.
+   */
   constructor(
     public url: string,
     public client: SkynetClient,
@@ -42,6 +55,14 @@ export class Connector {
 
   // Static initializer
 
+  /**
+   * Initializes a `Connector` instance.
+   *
+   * @param client - The Skynet Client.
+   * @param domain - The MySky domain to open.
+   * @param [customOptions] - Additional settings that can optionally be set.
+   * @returns - The `Connector`.
+   */
   static async init(client: SkynetClient, domain: string, customOptions?: CustomConnectorOptions): Promise<Connector> {
     const opts = { ...DEFAULT_CONNECTOR_OPTIONS, ...customOptions };
 
@@ -80,6 +101,13 @@ export class Connector {
     return new Connector(domainUrl, client, childFrame, connection, opts);
   }
 
+  /**
+   * Calls the given method with the given arguments.
+   *
+   * @param method - The remote method to call over the connection.
+   * @param args - The list of optional arguments.
+   * @returns - The result of the call.
+   */
   async call(method: string, ...args: unknown[]): Promise<unknown> {
     return this.connection.remoteHandle().call(method, ...args);
   }

src/mysky/dac.ts

@@ -5,18 +5,41 @@ import { Permission } from "skynet-mysky-utils";
 import { SkynetClient } from "../client";
 import { Connector, CustomConnectorOptions } from "./connector";
 
+/**
+ * The base DAC class with base and required methods.
+ */
 export abstract class DacLibrary {
   protected connector?: Connector;
 
+  /**
+   * Constructs the DAC.
+   *
+   * @param dacDomain - The domain of the DAC.
+   */
   public constructor(protected dacDomain: string) {}
 
+  /**
+   * Initializes the `Connector` with the DAC iframe and calls `init` on the
+   * DAC.
+   *
+   * @param client - The Skynet Client.
+   * @param customOptions - The custom options.
+   */
   public async init(client: SkynetClient, customOptions: CustomConnectorOptions): Promise<void> {
     this.connector = await Connector.init(client, this.dacDomain, customOptions);
     await this.connector.connection.remoteHandle().call("init");
   }
 
+  /**
+   * Returns the permissions required by the DAC.
+   *
+   * @returns - The DAC permissions.
+   */
   abstract getPermissions(): Permission[];
 
+  /**
+   * The hook to run on user login.
+   */
   async onUserLogin(): Promise<void> {
     if (!this.connector) {
       throw new Error("init was not called");