@rapidmx/autodiscover-plugin 1.0.0-beta.2 → 1.0.0

package/dist/lib/index.js

@@ -10,18 +10,15 @@
  * exported from this package's `./mongo`/`./sql` subpaths instead, alongside every other entity/route/job this
  * library defines - see `src/eas/index.ts`'s identical doc comment for the same convention.
  *
- * A deployment mounts Autodiscover with a trivial subclass supplying its own EAS URL:
- * ```ts
- * import { AutodiscoverRouteMongo } from "@rapidrest/mail/mongo";
- * import { RouteDecorators } from "@rapidrest/service-core";
- * const { Route } = RouteDecorators;
- *
- * @Route("/autodiscover")
- * export class MyAutodiscoverRoute extends AutodiscoverRouteMongo {
- *     protected readonly easUrl = "https://mail.example.com/Microsoft-Server-ActiveSync";
- *     protected readonly mapiUrl = "https://mail.example.com/mapi/emsmdb";
- * }
- * ```
+ * A deployment mounts Autodiscover by loading the ready-to-mount `AutodiscoverRouteMongo`/`AutodiscoverRouteSQL`
+ * class from this plugin's `./mongo`/`./sql` entry point directly - no subclass or URLs to supply, since
+ * `BaseAutodiscoverRoute` builds the EAS (`easUrl`) and MAPI (`mapiUrl`) endpoint URLs itself from the
+ * `mail:autodiscover:public_url` config setting (also exposed as this plugin's own "Public server URL"
+ * admin-console setting - see `package.json`'s `rapidmx.plugin.settings`), and only advertises each protocol
+ * while its own plugin (`@rapidmx/activesync-plugin`, `@rapidmx/mapi-plugin`) is loaded. Set
+ * `mail:autodiscover:public_url` to this deployment's externally-reachable `https://` base URL (e.g.
+ * `https://mail.example.com`) for either endpoint to be advertised at all - see `BaseAutodiscoverRoute`'s own
+ * doc comment for the exact validation rules.
  */
 export * from "./AutodiscoverXml.js";
 export * from "./BaseAutodiscoverRoute.js";

package/dist/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,mEAAmE;AACnE,mCAAmC;AACnC,+EAA+E;AAE/E;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,mEAAmE;AACnE,mCAAmC;AACnC,+EAA+E;AAE/E;;;;;;;;;;;;;;;;;GAiBG;AACH,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC"}

package/dist/types/index.d.ts

@@ -6,18 +6,15 @@
  * exported from this package's `./mongo`/`./sql` subpaths instead, alongside every other entity/route/job this
  * library defines - see `src/eas/index.ts`'s identical doc comment for the same convention.
  *
- * A deployment mounts Autodiscover with a trivial subclass supplying its own EAS URL:
- * ```ts
- * import { AutodiscoverRouteMongo } from "@rapidrest/mail/mongo";
- * import { RouteDecorators } from "@rapidrest/service-core";
- * const { Route } = RouteDecorators;
- *
- * @Route("/autodiscover")
- * export class MyAutodiscoverRoute extends AutodiscoverRouteMongo {
- *     protected readonly easUrl = "https://mail.example.com/Microsoft-Server-ActiveSync";
- *     protected readonly mapiUrl = "https://mail.example.com/mapi/emsmdb";
- * }
- * ```
+ * A deployment mounts Autodiscover by loading the ready-to-mount `AutodiscoverRouteMongo`/`AutodiscoverRouteSQL`
+ * class from this plugin's `./mongo`/`./sql` entry point directly - no subclass or URLs to supply, since
+ * `BaseAutodiscoverRoute` builds the EAS (`easUrl`) and MAPI (`mapiUrl`) endpoint URLs itself from the
+ * `mail:autodiscover:public_url` config setting (also exposed as this plugin's own "Public server URL"
+ * admin-console setting - see `package.json`'s `rapidmx.plugin.settings`), and only advertises each protocol
+ * while its own plugin (`@rapidmx/activesync-plugin`, `@rapidmx/mapi-plugin`) is loaded. Set
+ * `mail:autodiscover:public_url` to this deployment's externally-reachable `https://` base URL (e.g.
+ * `https://mail.example.com`) for either endpoint to be advertised at all - see `BaseAutodiscoverRoute`'s own
+ * doc comment for the exact validation rules.
  */
 export * from "./AutodiscoverXml.js";
 export * from "./BaseAutodiscoverRoute.js";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rapidmx/autodiscover-plugin",
-    "version": "1.0.0-beta.2",
+    "version": "1.0.0",
     "description": "A RapidMX plugin that provides Autodiscover protocol support.",
     "repository": "https://github.com/RapidMX/autodiscover.git",
     "author": "RapidREST <rapidrests@gmail.com>",
@@ -97,7 +97,8 @@
                     "key": "mail:autodiscover:public_url",
                     "label": "Public server URL",
                     "type": "string",
-                    "help": "The address clients reach this server at, for example https://mail.example.com. Nothing is advertised until this is set."
+                    "default": "",
+                    "help": "The address clients reach this server at, for example https://mail.example.com - the same host your DNS/MX setup already points at. Nothing is advertised until this is set. Also add a CNAME (autodiscover.<domain> -> this host) or, to avoid needing a second TLS certificate, a DNS SRV record (_autodiscover._tcp.<domain> -> this host) so mail clients can find this server automatically - see this deployment's Domain DNS setup checklist."
                 }
             ],
             "requires": {