@gusnips/one-click-dns 0.0.0-stage → 0.1.1

package/dist/index.d.cts

@@ -0,0 +1,119 @@
+import { D as DnsHostId } from './hosts-B0_V4Ned.cjs';
+export { a as DNS_HOSTS, b as DNS_HOST_IDS, c as DnsFields, d as DnsHost, e as DnsHostReading, f as DnsTrap, g as DnsTrapKind, h as DnsZone, i as detectDnsHosts, t as trapOf } from './hosts-B0_V4Ned.cjs';
+
+interface DnsRecordSpec {
+    type: "CNAME" | "TXT" | "MX";
+    /** The record's whole name: `help.acme.com`, `_dmarc.acme.com`, or the zone itself. */
+    name: string;
+    /** The target (CNAME, MX) or the text (TXT). `null` when no safe value is known. */
+    value: string | null;
+    /** The MX's priority. */
+    priority?: number;
+}
+interface DnsRecordRow {
+    type: DnsRecordSpec["type"];
+    /** The MX's priority; absent for every other type. */
+    priority?: number;
+    /** What goes in the name box. Empty: the host wants it left empty. */
+    name: string;
+    /** `null` when no safe value is known. */
+    value: string | null;
+    /** The record sits on the zone's own name, which hosts write in different ways. */
+    atRoot: boolean;
+    /** At the root, and no page of the host says how it writes it: `@` is a guess. */
+    rootUnsure: boolean;
+}
+/** The part of `name` before `zone`: `t` for `t.acme.com` in `acme.com`, empty for the zone
+ *  itself. A name outside the zone, or an unknown zone, stays whole. */
+declare function relativeName(name: string, zone: string | null): string;
+/** The record's name relative to `zone`, with `@` for the zone itself. Null when the zone was not
+ *  read. */
+declare function recordNameInZone(name: string, zone: string | null): string | null;
+/** One record as `host` wants it typed. `host` and `zone` are `null` when we could not tell:
+ *  the record then reads in the widest form (the whole name, `@` for the root, no quotes). */
+declare function dnsRecordRow(host: DnsHostId | null, zone: string | null, spec: DnsRecordSpec): DnsRecordRow;
+
+/** Trim a DNS name, lowercase it and remove one trailing ASCII dot.
+ *  This does not validate the name or convert international names to ASCII. */
+declare function normalizeDnsName(name: string): string;
+
+/** Who owns the templates. */
+interface TemplateIdentity {
+    /** A domain that will not be renamed (`getcolding.com`). Part of every file name. */
+    providerId: string;
+    /** The brand a person sees (`colding`). */
+    providerName: string;
+    logoUrl: string;
+    /** The domain whose DNS holds the public key (`_dck1.<syncPubKeyDomain>`). */
+    syncPubKeyDomain: string;
+    /** Where `redirect_uri` may point; a comma separates several. */
+    syncRedirectDomain: string;
+}
+interface TemplateRecord {
+    type: "CNAME" | "TXT" | "MX" | "SPFM";
+    /** The label inside the customer's name; `@` is the name itself. */
+    host: string;
+    pointsTo?: string;
+    data?: string;
+    priority?: number;
+    spfRules?: string;
+    ttl?: number;
+    essential?: "OnApply";
+    txtConflictMatchingMode?: "All" | "Prefix";
+    txtConflictMatchingPrefix?: string;
+}
+interface DomainConnectTemplate extends TemplateIdentity {
+    serviceId: string;
+    serviceName: string;
+    version: number;
+    description: string;
+    variableDescription?: string;
+    /** The subdomain is required: the template has no meaning at the name itself. */
+    hostRequired?: boolean;
+    records: TemplateRecord[];
+}
+/** What every preset lets the app word itself. */
+interface Wording {
+    serviceId?: string;
+    serviceName?: string;
+    description?: string;
+    version?: number;
+}
+/** The `<providerId>.<serviceId>.json` name the Templates repository files it under. */
+declare function templateFileName(t: Pick<DomainConnectTemplate, "providerId" | "serviceId">): string;
+/**
+ * A subdomain that points at you: a custom domain, a tracking host, a help center. The
+ * subdomain is the link's `host`; `pointsTo` may hold a variable (`%target%.cname.example.com`).
+ */
+declare function cnameTemplate(identity: TemplateIdentity, options: Wording & {
+    pointsTo: string;
+    variableDescription?: string;
+}): DomainConnectTemplate;
+/**
+ * A DMARC record that only watches (`p=none`) and rejects nothing; a stricter policy is the
+ * domain owner's call. With `rua`, the link carries the address that gets the reports.
+ */
+declare function dmarcTemplate(identity: TemplateIdentity, options?: Wording & {
+    rua?: boolean;
+}): DomainConnectTemplate;
+/** Adds one `include:` to the domain's SPF record. `SPFM` merges it into the one record the
+ *  name may have; a TXT would make a second one and break SPF. The link carries `%include%`. */
+declare function spfTemplate(identity: TemplateIdentity, options?: Wording): DomainConnectTemplate;
+/** DKIM as CNAMEs, for services that publish the key on their side. The link carries
+ *  `%selector1%` and `%target1%`, then the same pair numbered up to `keys`. */
+declare function dkimTemplate(identity: TemplateIdentity, options?: Wording & {
+    keys?: number;
+}): DomainConnectTemplate;
+/** The MX record that sends the domain's mail to you. */
+declare function mxTemplate(identity: TemplateIdentity, options: Wording & {
+    pointsTo: string;
+    priority?: number;
+}): DomainConnectTemplate;
+/** A TXT record that proves you own the domain: a fixed prefix and the token the link carries
+ *  as `%value%`. Only one may sit at the name, so a new token replaces the old one. */
+declare function verificationTemplate(identity: TemplateIdentity, options: Wording & {
+    prefix: string;
+    host?: string;
+}): DomainConnectTemplate;
+
+export { DnsHostId, type DnsRecordRow, type DnsRecordSpec, type DomainConnectTemplate, type TemplateIdentity, type TemplateRecord, cnameTemplate, dkimTemplate, dmarcTemplate, dnsRecordRow, mxTemplate, normalizeDnsName, recordNameInZone, relativeName, spfTemplate, templateFileName, verificationTemplate };

package/dist/index.d.ts

@@ -0,0 +1,119 @@
+import { D as DnsHostId } from './hosts-B0_V4Ned.js';
+export { a as DNS_HOSTS, b as DNS_HOST_IDS, c as DnsFields, d as DnsHost, e as DnsHostReading, f as DnsTrap, g as DnsTrapKind, h as DnsZone, i as detectDnsHosts, t as trapOf } from './hosts-B0_V4Ned.js';
+
+interface DnsRecordSpec {
+    type: "CNAME" | "TXT" | "MX";
+    /** The record's whole name: `help.acme.com`, `_dmarc.acme.com`, or the zone itself. */
+    name: string;
+    /** The target (CNAME, MX) or the text (TXT). `null` when no safe value is known. */
+    value: string | null;
+    /** The MX's priority. */
+    priority?: number;
+}
+interface DnsRecordRow {
+    type: DnsRecordSpec["type"];
+    /** The MX's priority; absent for every other type. */
+    priority?: number;
+    /** What goes in the name box. Empty: the host wants it left empty. */
+    name: string;
+    /** `null` when no safe value is known. */
+    value: string | null;
+    /** The record sits on the zone's own name, which hosts write in different ways. */
+    atRoot: boolean;
+    /** At the root, and no page of the host says how it writes it: `@` is a guess. */
+    rootUnsure: boolean;
+}
+/** The part of `name` before `zone`: `t` for `t.acme.com` in `acme.com`, empty for the zone
+ *  itself. A name outside the zone, or an unknown zone, stays whole. */
+declare function relativeName(name: string, zone: string | null): string;
+/** The record's name relative to `zone`, with `@` for the zone itself. Null when the zone was not
+ *  read. */
+declare function recordNameInZone(name: string, zone: string | null): string | null;
+/** One record as `host` wants it typed. `host` and `zone` are `null` when we could not tell:
+ *  the record then reads in the widest form (the whole name, `@` for the root, no quotes). */
+declare function dnsRecordRow(host: DnsHostId | null, zone: string | null, spec: DnsRecordSpec): DnsRecordRow;
+
+/** Trim a DNS name, lowercase it and remove one trailing ASCII dot.
+ *  This does not validate the name or convert international names to ASCII. */
+declare function normalizeDnsName(name: string): string;
+
+/** Who owns the templates. */
+interface TemplateIdentity {
+    /** A domain that will not be renamed (`getcolding.com`). Part of every file name. */
+    providerId: string;
+    /** The brand a person sees (`colding`). */
+    providerName: string;
+    logoUrl: string;
+    /** The domain whose DNS holds the public key (`_dck1.<syncPubKeyDomain>`). */
+    syncPubKeyDomain: string;
+    /** Where `redirect_uri` may point; a comma separates several. */
+    syncRedirectDomain: string;
+}
+interface TemplateRecord {
+    type: "CNAME" | "TXT" | "MX" | "SPFM";
+    /** The label inside the customer's name; `@` is the name itself. */
+    host: string;
+    pointsTo?: string;
+    data?: string;
+    priority?: number;
+    spfRules?: string;
+    ttl?: number;
+    essential?: "OnApply";
+    txtConflictMatchingMode?: "All" | "Prefix";
+    txtConflictMatchingPrefix?: string;
+}
+interface DomainConnectTemplate extends TemplateIdentity {
+    serviceId: string;
+    serviceName: string;
+    version: number;
+    description: string;
+    variableDescription?: string;
+    /** The subdomain is required: the template has no meaning at the name itself. */
+    hostRequired?: boolean;
+    records: TemplateRecord[];
+}
+/** What every preset lets the app word itself. */
+interface Wording {
+    serviceId?: string;
+    serviceName?: string;
+    description?: string;
+    version?: number;
+}
+/** The `<providerId>.<serviceId>.json` name the Templates repository files it under. */
+declare function templateFileName(t: Pick<DomainConnectTemplate, "providerId" | "serviceId">): string;
+/**
+ * A subdomain that points at you: a custom domain, a tracking host, a help center. The
+ * subdomain is the link's `host`; `pointsTo` may hold a variable (`%target%.cname.example.com`).
+ */
+declare function cnameTemplate(identity: TemplateIdentity, options: Wording & {
+    pointsTo: string;
+    variableDescription?: string;
+}): DomainConnectTemplate;
+/**
+ * A DMARC record that only watches (`p=none`) and rejects nothing; a stricter policy is the
+ * domain owner's call. With `rua`, the link carries the address that gets the reports.
+ */
+declare function dmarcTemplate(identity: TemplateIdentity, options?: Wording & {
+    rua?: boolean;
+}): DomainConnectTemplate;
+/** Adds one `include:` to the domain's SPF record. `SPFM` merges it into the one record the
+ *  name may have; a TXT would make a second one and break SPF. The link carries `%include%`. */
+declare function spfTemplate(identity: TemplateIdentity, options?: Wording): DomainConnectTemplate;
+/** DKIM as CNAMEs, for services that publish the key on their side. The link carries
+ *  `%selector1%` and `%target1%`, then the same pair numbered up to `keys`. */
+declare function dkimTemplate(identity: TemplateIdentity, options?: Wording & {
+    keys?: number;
+}): DomainConnectTemplate;
+/** The MX record that sends the domain's mail to you. */
+declare function mxTemplate(identity: TemplateIdentity, options: Wording & {
+    pointsTo: string;
+    priority?: number;
+}): DomainConnectTemplate;
+/** A TXT record that proves you own the domain: a fixed prefix and the token the link carries
+ *  as `%value%`. Only one may sit at the name, so a new token replaces the old one. */
+declare function verificationTemplate(identity: TemplateIdentity, options: Wording & {
+    prefix: string;
+    host?: string;
+}): DomainConnectTemplate;
+
+export { DnsHostId, type DnsRecordRow, type DnsRecordSpec, type DomainConnectTemplate, type TemplateIdentity, type TemplateRecord, cnameTemplate, dkimTemplate, dmarcTemplate, dnsRecordRow, mxTemplate, normalizeDnsName, recordNameInZone, relativeName, spfTemplate, templateFileName, verificationTemplate };

package/dist/index.js

@@ -0,0 +1,198 @@
+import {
+  DNS_HOSTS,
+  DNS_HOST_IDS,
+  detectDnsHosts,
+  trapOf
+} from "./chunk-2T2PEF4H.js";
+import {
+  normalizeDnsName
+} from "./chunk-P2O7INDB.js";
+
+// src/records.ts
+function relativeName(name, zone) {
+  if (!zone) return name;
+  if (name === zone) return "";
+  return name.endsWith(`.${zone}`) ? name.slice(0, -(zone.length + 1)) : name;
+}
+function recordNameInZone(name, zone) {
+  if (!zone) return null;
+  return relativeName(name, zone) || "@";
+}
+function dnsRecordRow(host, zone, spec) {
+  const data = host ? DNS_HOSTS[host] : null;
+  const relative = relativeName(spec.name, zone);
+  const atRoot = spec.type !== "CNAME" && relative === "";
+  const name = atRoot ? data?.root ?? "@" : relative || spec.name;
+  if (spec.type === "CNAME" || spec.type === "MX") {
+    const target = spec.value && data && trapOf(data, "trailingDot") ? `${spec.value}.` : spec.value;
+    if (spec.type === "CNAME")
+      return { type: "CNAME", name, value: target, atRoot: false, rootUnsure: false };
+    return {
+      type: "MX",
+      name,
+      value: target,
+      priority: spec.priority,
+      atRoot,
+      rootUnsure: atRoot && (!data || data.root === null)
+    };
+  }
+  return {
+    type: "TXT",
+    name,
+    value: spec.value && data && trapOf(data, "quotedTxt") ? `"${spec.value}"` : spec.value,
+    atRoot,
+    rootUnsure: atRoot && (!data || data.root === null)
+  };
+}
+
+// src/templates.ts
+var TTL = 3600;
+function template(identity, serviceId, fallback, wording, records, hostRequired) {
+  return {
+    providerId: identity.providerId,
+    providerName: identity.providerName,
+    serviceId: wording.serviceId ?? serviceId,
+    serviceName: wording.serviceName ?? fallback.serviceName,
+    version: wording.version ?? 1,
+    logoUrl: identity.logoUrl,
+    description: wording.description ?? fallback.description,
+    ...fallback.variableDescription ? { variableDescription: fallback.variableDescription } : {},
+    syncPubKeyDomain: identity.syncPubKeyDomain,
+    syncRedirectDomain: identity.syncRedirectDomain,
+    ...hostRequired ? { hostRequired } : {},
+    records
+  };
+}
+function templateFileName(t) {
+  return `${t.providerId}.${t.serviceId}.json`.toLowerCase();
+}
+function cnameTemplate(identity, options) {
+  return template(
+    identity,
+    options.serviceId ?? "custom-domain",
+    {
+      serviceName: "Connect a custom domain",
+      description: "Points your subdomain at us. The subdomain is the host parameter.",
+      variableDescription: options.variableDescription
+    },
+    options,
+    [{ type: "CNAME", host: "@", pointsTo: options.pointsTo, ttl: TTL }],
+    true
+  );
+}
+function dmarcTemplate(identity, options = {}) {
+  return template(
+    identity,
+    "dmarc",
+    {
+      serviceName: "DMARC record for your sending domain",
+      description: "Adds a DMARC record that only monitors (p=none), so mailbox providers can see that your sending domain has a policy. It rejects and quarantines nothing.",
+      variableDescription: options.rua ? "%dmarcRua%: the email address that gets the DMARC aggregate reports." : void 0
+    },
+    options,
+    [
+      {
+        type: "TXT",
+        host: "_dmarc",
+        data: options.rua ? "v=DMARC1; p=none; rua=mailto:%dmarcRua%" : "v=DMARC1; p=none",
+        ttl: TTL,
+        txtConflictMatchingMode: "Prefix",
+        txtConflictMatchingPrefix: "v=DMARC1",
+        essential: "OnApply"
+      }
+    ]
+  );
+}
+function spfTemplate(identity, options = {}) {
+  return template(
+    identity,
+    "spf",
+    {
+      serviceName: "Allow us to send email for your domain",
+      description: "Adds our sending service to your domain's SPF record, next to what is already there.",
+      variableDescription: "%include%: the domain to include, such as _spf.example.com."
+    },
+    options,
+    [{ type: "SPFM", host: "@", spfRules: "include:%include%" }]
+  );
+}
+function dkimTemplate(identity, options = {}) {
+  const keys = options.keys ?? 2;
+  const numbers = Array.from({ length: keys }, (_, index) => index + 1);
+  return template(
+    identity,
+    "dkim",
+    {
+      serviceName: "Sign your email with our key",
+      description: "Adds the CNAME records that let us sign email sent from your domain.",
+      variableDescription: numbers.map((n) => `%selector${n}%: the key name, ${n} of ${keys}; %target${n}%: where it points`).join("; ")
+    },
+    options,
+    numbers.map((n) => ({
+      type: "CNAME",
+      host: `%selector${n}%._domainkey`,
+      pointsTo: `%target${n}%`,
+      ttl: TTL
+    }))
+  );
+}
+function mxTemplate(identity, options) {
+  return template(
+    identity,
+    "mx",
+    {
+      serviceName: "Receive email for your domain with us",
+      description: "Sends the email for your domain to our mail servers."
+    },
+    options,
+    [
+      {
+        type: "MX",
+        host: "@",
+        pointsTo: options.pointsTo,
+        priority: options.priority ?? 10,
+        ttl: TTL
+      }
+    ]
+  );
+}
+function verificationTemplate(identity, options) {
+  return template(
+    identity,
+    "domain-verification",
+    {
+      serviceName: "Verify your domain",
+      description: "Adds the record that shows us you own this domain.",
+      variableDescription: "%value%: the verification token we gave you."
+    },
+    options,
+    [
+      {
+        type: "TXT",
+        host: options.host ?? "@",
+        data: `${options.prefix}%value%`,
+        ttl: TTL,
+        txtConflictMatchingMode: "Prefix",
+        txtConflictMatchingPrefix: options.prefix,
+        essential: "OnApply"
+      }
+    ]
+  );
+}
+export {
+  DNS_HOSTS,
+  DNS_HOST_IDS,
+  cnameTemplate,
+  detectDnsHosts,
+  dkimTemplate,
+  dmarcTemplate,
+  dnsRecordRow,
+  mxTemplate,
+  normalizeDnsName,
+  recordNameInZone,
+  relativeName,
+  spfTemplate,
+  templateFileName,
+  trapOf,
+  verificationTemplate
+};