arcy.js 0.1.0 → 0.1.2

package/dist/index.d.ts

@@ -22,6 +22,21 @@ type Unsubscribe = () => void;
  */
 type AttributeValue = string | number | boolean | null | string[];
 type Attributes = Record<string, AttributeValue>;
+/**
+ * What a caller may hand `identify()`, and it is deliberately wider than what
+ * goes on the wire (ADR 0194).
+ *
+ * `undefined` means "nothing to send for this key": the key is dropped from the
+ * payload before it leaves the browser, silently, and never reaches the server.
+ * It exists because every auth SDK returns optional fields, so the line an
+ * operator naturally writes is `user_email: user.primaryEmailAddress?.emailAddress`,
+ * and a type that refuses it refuses the install snippet we publish.
+ *
+ * This keeps the three spellings distinct. An absent key means "do not touch",
+ * `null` means "clear it", and a value means "set it". `undefined` is the first
+ * of those, spelled the way JavaScript spells it.
+ */
+type AttributesInput = Record<string, AttributeValue | undefined>;
 /**
  * The complete set of `init()` options, and it is complete by design
  * (PRODUCT_SCOPE §11.5.1, resolved at G1 as Q41). **Reopened once, D733**
@@ -41,6 +56,21 @@ type Attributes = Record<string, AttributeValue>;
 interface ArcyOptions {
     /** Consent signal for behavioral telemetry. A cookie banner is code. */
     telemetry?: boolean;
+    /**
+     * Where the widget talks to ARCY, if not `https://api.arcyai.com`.
+     *
+     * The fifth escape hatch (D1396, ADR 0186), and it exists for one reason:
+     * a page under a Content Security Policy has to name every origin the
+     * widget reaches, and a customer who would rather name none can rewrite a
+     * path on their own domain to our API and pass it here. Session, chat,
+     * flows, telemetry, image uploads and the panel's web fonts all follow it,
+     * so proxying moves the whole widget rather than most of it.
+     *
+     * An origin or an origin with a path prefix, no trailing slash, for
+     * example `https://example.com/_arcy`. Anything that is not a string is
+     * ignored with a warning, like every other bad option.
+     */
+    apiBase?: string;
     /**
      * The host app usually knows the user's language before ARCY loads.
      *
@@ -106,9 +136,9 @@ interface IdentifyOptions {
 }
 interface Arcy {
     init(token: string, options?: ArcyOptions): Promise<void>;
-    identify(userId: string, attributes?: Attributes, options?: IdentifyOptions): Promise<void>;
-    identifyAnonymous(attributes?: Attributes): Promise<void>;
-    updateUser(attributes?: Attributes): Promise<void>;
+    identify(userId: string, attributes?: AttributesInput, options?: IdentifyOptions): Promise<void>;
+    identifyAnonymous(attributes?: AttributesInput): Promise<void>;
+    updateUser(attributes?: AttributesInput): Promise<void>;
     reset(): void;
     open(): void;
     close(): void;
@@ -121,13 +151,19 @@ interface Arcy {
  * so the ESM, CJS, and IIFE builds all carry the same value with no build-time
  * indirection. Bumped with the package version.
  */
-declare const VERSION = "0.1.0";
+declare const VERSION = "0.1.1";
 
 /**
- * The namespace object. In the HTML build this is what `window.arcy` is; in
- * the npm build it is the default export. Both builds resolve to the same
- * object so a call written against one path behaves identically on the other.
+ * The namespace object, and the npm build's default export. `src/browser.ts`
+ * builds the same object for `window.arcy` on the script path.
+ *
+ * The two entry points differ in exactly one argument (ADR 0185): this one
+ * loads the chat panel, the flow engine and the picker with `import()`, so
+ * they become chunks in the customer's own build on the customer's own
+ * origin. The script build injects them from the CDN, which is the origin
+ * its install snippet already comes from. Nothing else about the two paths
+ * differs, and a call written against one behaves identically on the other.
  */
 declare const arcy: Arcy;
 
-export { type Arcy, type ArcyEvent, type ArcyEventHandler, type ArcyOptions, type AttributeValue, type Attributes, type Unsubscribe, VERSION, arcy as default };
+export { type Arcy, type ArcyEvent, type ArcyEventHandler, type ArcyOptions, type AttributeValue, type Attributes, type AttributesInput, type Unsubscribe, VERSION, arcy as default };