@zthun/helpful-internet 2.4.0 → 3.2.0

package/README.md

@@ -0,0 +1,11 @@
+# Helpful Internet
+
+This package contains models for common internet "things." These can be generic everyday objects such as emails,
+cookies, and servers.
+
+## Installation
+
+```sh
+npm install @zthun/helpful-internet
+yarn add @zthun/helpful-internet
+```

package/dist/{types/cookie/cookie.d.ts → cookie/cookie.d.mts}

@@ -84,9 +84,6 @@ export declare class ZCookieBuilder {
     /**
      * Sets the cookie expiration date to one day from the moment this is invoked.
      *
-     * @param val -
-     *        The value to set.
-     *
      * @returns
      *        This object.
      */

package/dist/{types/email/email-contact-address.d.ts → email/email-contact-address.d.mts}

@@ -1,4 +1,4 @@
-import { IZEmailContact } from './email-contact';
+import { IZEmailContact } from './email-contact.mjs';
 /**
  * Represents a builder that will build a comma separated
  * list of addresses for an email message.

package/dist/{types/email/email-envelope.d.ts → email/email-envelope.d.mts}

@@ -1,4 +1,4 @@
-import { IZEmailContact } from './email-contact';
+import { IZEmailContact } from './email-contact.mjs';
 /**
  * Represents an email envelope of information about who the email is from and where it's going to.
  */

package/dist/{types/email/email.d.ts → email/email.d.mts}

@@ -1,4 +1,4 @@
-import { IZEmailEnvelope } from './email-envelope';
+import { IZEmailEnvelope } from './email-envelope.mjs';
 /**
  * Represents an email message.
  */

package/dist/index.cjs

@@ -0,0 +1,637 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const _ZCookieBuilder = class _ZCookieBuilder {
+  /**
+   * Initializes a new instance of this object.
+   */
+  constructor() {
+    this.immortal = this.expires.bind(this, void 0);
+    this.lax = this.sameSite.bind(this, "lax");
+    this.strict = this.sameSite.bind(this, "strict");
+    this._cookie = {
+      name: "",
+      value: ""
+    };
+  }
+  /**
+   * Sets the cookie name.
+   *
+   * @param val -
+   *        The value to set.
+   *
+   * @returns
+   *        This object.
+   */
+  name(val) {
+    this._cookie.name = val;
+    return this;
+  }
+  /**
+   * Sets the cookie value.
+   *
+   * @param val -
+   *        The value to set.
+   *
+   * @returns
+   *        This object.
+   */
+  value(val) {
+    this._cookie.value = val;
+    return this;
+  }
+  /**
+   * Sets the cookie domain.
+   *
+   * @param val -
+   *        The value to set.
+   *
+   * @returns
+   *        This object.
+   */
+  domain(val) {
+    this._cookie.domain = val;
+    return this;
+  }
+  /**
+   * Sets the cookie expiration date.
+   *
+   * @param val -
+   *        The value to set.
+   *
+   * @returns
+   *        This object.
+   */
+  expires(val) {
+    if (val == null) {
+      delete this._cookie.expires;
+      return this;
+    }
+    this._cookie.expires = typeof val === "string" ? val : val.toJSON();
+    return this;
+  }
+  /**
+   * Sets the cookie expiration date to one day from the moment this is invoked.
+   *
+   * @returns
+   *        This object.
+   */
+  expiresTomorrow() {
+    return this.expires(new Date(Date.now() + _ZCookieBuilder.MillisecondsOneDay));
+  }
+  /**
+   * Sets the cookie secure flag.
+   *
+   * @param val -
+   *        The value to set.
+   *
+   * @returns
+   *        This object.
+   */
+  secure(val = true) {
+    this._cookie.secure = val;
+    return this;
+  }
+  /**
+   * Sets the cookie same site policy.
+   *
+   * @param val -
+   *        The value to set.
+   *
+   * @returns
+   *        This object.
+   */
+  sameSite(val) {
+    this._cookie.sameSite = val;
+    return this;
+  }
+  /**
+   * Sets the same site policy to 'none' and turns on the secure flag.
+   *
+   * @returns
+   *        This object.
+   */
+  allowCrossSite() {
+    return this.secure().sameSite("none");
+  }
+  /**
+   * Sets the cookie http only flag.
+   *
+   * @param val -
+   *        The value to set.
+   *
+   * @returns
+   *        This object.
+   */
+  httpOnly(val = true) {
+    this._cookie.httpOnly = val;
+    return this;
+  }
+  /**
+   * Creates a token based authentication cookie.
+   *
+   * @param token -
+   *        The token value for the cookie.  You
+   *        can leave this as undefined to set it
+   *        later.
+   *
+   * @returns
+   *        This object.
+   */
+  authentication(token) {
+    const builder = this.name("Authentication").expiresTomorrow().secure().httpOnly();
+    return token == null ? builder : builder.value(token);
+  }
+  /**
+   * Returns a copy of the built instance of the cookie.
+   *
+   * @returns
+   *        A shallow copy of the current cookie object.
+   */
+  build() {
+    return { ...this._cookie };
+  }
+};
+_ZCookieBuilder.MillisecondsOneDay = 864e5;
+let ZCookieBuilder = _ZCookieBuilder;
+class ZEmailContactAddressBuilder {
+  constructor() {
+    this._addresses = [];
+    this._delimiter = ", ";
+  }
+  /**
+   * Adds an address to the list to builder.
+   *
+   * @param val -
+   *        The address to add. This can be the empty string,
+   *        null, or undefined.
+   *
+   * @returns
+   *        This object.
+   */
+  address(val) {
+    this._addresses.push(val);
+    return this;
+  }
+  /**
+   * Sets the addresses to build from.
+   *
+   * @param val -
+   *        The address to set.
+   *
+   * @returns
+   *        This object.
+   */
+  addresses(val) {
+    this._addresses = val.slice();
+    return this;
+  }
+  /**
+   * Sets the delimiter to split the addresses with.
+   *
+   * The default is a comma with a space.
+   *
+   * @param val -
+   *        The delimiter to set.
+   *
+   * @returns
+   *        This object.
+   */
+  delimiter(val) {
+    this._delimiter = val;
+    return this;
+  }
+  /**
+   * Builds the delimiters separated list of addresses.
+   *
+   * @returns
+   *        The delimited separated list of addresses.
+   */
+  build() {
+    const addr = (ct) => {
+      if (!ct) {
+        return void 0;
+      }
+      return typeof ct === "string" ? ct : ct.address;
+    };
+    const truthy = (ct) => {
+      return !!ct;
+    };
+    return this._addresses.map(addr).filter(truthy).join(this._delimiter);
+  }
+}
+class ZEmailContactBuilder {
+  /**
+   * Initializes a new instance of this object.
+   */
+  constructor() {
+    this._contact = {
+      address: ""
+    };
+  }
+  /**
+   * Sets the address of the contact.
+   *
+   * @param val -
+   *        The value to set.
+   *
+   * @returns
+   *        This object.
+   */
+  address(val) {
+    this._contact.address = val;
+    return this;
+  }
+  /**
+   * Sets the type of the contact.
+   *
+   * @param val -
+   *        The value to set.
+   *
+   * @returns
+   *        This object.
+   */
+  type(val) {
+    this._contact.type = val;
+    return this;
+  }
+  /**
+   * Sets the display of the contact.
+   *
+   * @param val -
+   *        The value to set.
+   *
+   * @returns
+   *        This object.
+   */
+  display(val) {
+    this._contact.display = val;
+    return this;
+  }
+  /**
+   * Assigns the values in other to this object.
+   *
+   * @param other -
+   *        The value to partial copy.
+   *
+   * @returns
+   *        This object.
+   */
+  assign(other) {
+    this._contact = Object.assign({}, this._contact, other);
+    this._contact = JSON.parse(JSON.stringify(this._contact));
+    return this;
+  }
+  /**
+   * Copies another object.
+   *
+   * @param other -
+   *        The value to copy.
+   *
+   * @returns
+   *        This object.
+   */
+  copy(other) {
+    this._contact = JSON.parse(JSON.stringify(other));
+    return this;
+  }
+  /**
+   * Returns a copy of the built object.
+   *
+   * @returns
+   *        A copy of the built email contact.
+   */
+  build() {
+    return JSON.parse(JSON.stringify(this._contact));
+  }
+}
+class ZEmailEnvelopeBuilder {
+  /**
+   * Initializes a new instance of this object.
+   */
+  constructor() {
+    this._envelope = {
+      from: ""
+    };
+  }
+  /**
+   * Sets the from field.
+   *
+   * @param val -
+   *        The value to set.
+   *
+   * @returns
+   *        This object.
+   */
+  from(val) {
+    this._envelope.from = val;
+    return this;
+  }
+  /**
+   * Adds a value to the 'to' field.
+   *
+   * @param val -
+   *        The value to add.
+   *
+   * @returns
+   *        This object.
+   */
+  to(val) {
+    this._envelope.to = this._envelope.to || [];
+    this._envelope.to.push(val);
+    return this;
+  }
+  /**
+   * Sets the to field.
+   *
+   * @param val -
+   *        The value to set.
+   *
+   * @returns
+   *        This object.
+   */
+  tos(val) {
+    this._envelope.to = val;
+    return this;
+  }
+  /**
+   * Adds a value to the cc field.
+   *
+   * @param val -
+   *        The value to add.
+   *
+   * @returns
+   *        This object.
+   */
+  cc(val) {
+    this._envelope.cc = this._envelope.cc || [];
+    this._envelope.cc.push(val);
+    return this;
+  }
+  /**
+   * Sets the cc field.
+   *
+   * @param val -
+   *        The value to set.
+   *
+   * @returns
+   *        This object.
+   */
+  ccs(val) {
+    this._envelope.cc = val;
+    return this;
+  }
+  /**
+   * Adds a value to the bcc field.
+   *
+   * @param val -
+   *        The value to add.
+   *
+   * @returns
+   *        This object.
+   */
+  bcc(val) {
+    this._envelope.bcc = this._envelope.bcc || [];
+    this._envelope.bcc.push(val);
+    return this;
+  }
+  /**
+   * Sets the bcc field.
+   *
+   * @param val -
+   *        The value to set.
+   *
+   * @returns
+   *        This object.
+   */
+  bccs(val) {
+    this._envelope.bcc = val;
+    return this;
+  }
+  /**
+   * Assigns another partial email envelope to this object.
+   *
+   * @param other -
+   *        The value to partial copy.
+   *
+   * @returns
+   *        This object.
+   */
+  assign(other) {
+    this._envelope = Object.assign({}, this._envelope, other);
+    this._envelope = JSON.parse(JSON.stringify(this._envelope));
+    return this;
+  }
+  /**
+   * Copies another email envelope to this object.
+   *
+   * @param other -
+   *        The value to copy.
+   *
+   * @returns
+   *        This object.
+   */
+  copy(other) {
+    this._envelope = JSON.parse(JSON.stringify(other));
+    return this;
+  }
+  /**
+   * Returns a copy of the built envelope.
+   *
+   * @returns
+   *        A copy of the currently built up envelope object.
+   */
+  build() {
+    return JSON.parse(JSON.stringify(this._envelope));
+  }
+}
+class ZEmailBuilder {
+  /**
+   * Initializes a new instance of this object.
+   */
+  constructor() {
+    this._email = {
+      envelope: new ZEmailEnvelopeBuilder().build()
+    };
+  }
+  /**
+   * Sets the envelope of where the email is going.
+   *
+   * @param val -
+   *        The value to set.
+   *
+   * @returns
+   *        This object.
+   */
+  envelope(val) {
+    this._email.envelope = val;
+    return this;
+  }
+  /**
+   * Sets the subject line of the email.
+   *
+   * @param val -
+   *        The value to set.
+   *
+   * @returns
+   *        This object.
+   */
+  subject(val) {
+    this._email.subject = val;
+    return this;
+  }
+  /**
+   * Sets the message of the email.
+   *
+   * The message can be raw text or html.
+   *
+   * @param val -
+   *        A html enabled formatted message to set.
+   *
+   * @returns
+   *        This object.
+   */
+  message(val) {
+    this._email.message = val;
+    return this;
+  }
+  /**
+   * Assigns the other object to the current email object.
+   *
+   * @param other -
+   *        The object to copy.
+   *
+   * @returns
+   *        This object.
+   */
+  assign(other) {
+    this._email = Object.assign(this._email, other);
+    this._email = JSON.parse(JSON.stringify(this._email));
+    return this;
+  }
+  /**
+   * Copies another email into the builder.
+   *
+   * @param other -
+   *        The object to copy.
+   *
+   * @returns
+   *        This object.
+   */
+  copy(other) {
+    this._email = JSON.parse(JSON.stringify(other));
+    return this;
+  }
+  /**
+   * Returns a copy of the built object.
+   *
+   * @returns
+   *        A copy of the built object.
+   */
+  build() {
+    return JSON.parse(JSON.stringify(this._email));
+  }
+}
+class ZServerBuilder {
+  /**
+   * Initializes a new instance of this object.
+   */
+  constructor() {
+    this._server = {
+      address: ""
+    };
+  }
+  /**
+   * The server ip address or hostname.
+   *
+   * @param val -
+   *        The value to set.
+   *
+   * @returns
+   *        This object.
+   */
+  address(val) {
+    this._server.address = val;
+    return this;
+  }
+  /**
+   * Sets the optional port to connect on.
+   *
+   * @param val -
+   *        The value to set.
+   *
+   * @returns
+   *        This object.
+   */
+  port(val) {
+    this._server.port = val;
+    return this;
+  }
+  /**
+   * Sets the optional username to connect on.
+   *
+   * @param val -
+   *        The value to set.
+   *
+   * @returns
+   *        This object.
+   */
+  username(val) {
+    this._server.username = val;
+    return this;
+  }
+  /**
+   * Sets the password to connect on.
+   *
+   * @param val -
+   *        The value to set.
+   *
+   * @returns
+   *        This object.
+   */
+  password(val) {
+    this._server.password = val;
+    return this;
+  }
+  /**
+   * Assigns all truthy properties in other to this object.
+   *
+   * @param other -
+   *        The server object to copy.
+   *
+   * @returns
+   *        This object.
+   */
+  assign(other) {
+    this._server = Object.assign({}, this._server, other);
+    return this;
+  }
+  /**
+   * Copies all properties in other to this object.
+   *
+   * @param other -
+   *        The server object to copy.
+   *
+   * @returns
+   *        This object.
+   */
+  copy(other) {
+    this._server = JSON.parse(JSON.stringify(other));
+    return this;
+  }
+  /**
+   * Returns a copy of the built object.
+   *
+   * @returns
+   *        A copy of the built object.
+   */
+  build() {
+    return JSON.parse(JSON.stringify(this._server));
+  }
+}
+exports.ZCookieBuilder = ZCookieBuilder;
+exports.ZEmailBuilder = ZEmailBuilder;
+exports.ZEmailContactAddressBuilder = ZEmailContactAddressBuilder;
+exports.ZEmailContactBuilder = ZEmailContactBuilder;
+exports.ZEmailEnvelopeBuilder = ZEmailEnvelopeBuilder;
+exports.ZServerBuilder = ZServerBuilder;
+//# sourceMappingURL=index.cjs.map