@msg91comm/m91 0.0.0-stage → 1.2.0

package/dist/src/models.js

@@ -0,0 +1,383 @@
+/**
+ * Every shape the API returns, plus the local validation that stops a doomed
+ * request before it leaves the process.
+ *
+ * Two rules govern this file:
+ *
+ * - **Parse defensively.** The server omits a field rather than sending it
+ *   false or zero — `deduplicated`, `noDevice`, `pending`, `reopened` and
+ *   `message` are present only when they have something to say.
+ * - **Emit exactly.** Every request schema server-side is `.strict()`: an
+ *   unknown field is a 400, and so is `null` where a string was declared. So
+ *   `buildAlertPayload` *omits* what the caller left unset.
+ */
+import { M91ValidationError } from './exceptions.js';
+export const SEVERITIES = ['LOW', 'MEDIUM', 'HIGH', 'CRITICAL'];
+export const EFFECTS = ['SHARED', 'PERSONAL'];
+/** Severities that place a voice call after 45s with no answer. */
+export const ESCALATING_SEVERITIES = ['HIGH', 'CRITICAL'];
+export const TITLE_MIN = 5;
+export const TITLE_MAX = 2000;
+export const DESCRIPTION_MAX = 2000;
+export const CUSTOM_ID_MAX = 200;
+export const LABEL_MAX = 24;
+export const ATTACHMENT_URL_MAX = 2000;
+const CALLBACK_URL_MAX = 2000;
+const MAX_RESPONSE_OPTIONS = 20;
+export const MAX_LINK_RESPONSE_OPTIONS = 6;
+export const CHANNEL_NAME_MAX = 80;
+export const MAX_MEMBERS_PER_CALL = 500;
+/** Mirrors `validation/common.js` — digits only, country code included, no `+`. */
+const PHONE_RE = /^\d{8,15}$/;
+/** The only two things an option may ask somebody to supply. */
+export const COLLECTABLE = ['note', 'attachment'];
+const asRaw = (value) => (value && typeof value === 'object' ? value : {});
+const str = (value) => (value === null || value === undefined ? null : String(value));
+const num = (value) => (Number.isFinite(Number(value)) ? Number(value) : 0);
+const arr = (value) => (Array.isArray(value) ? value : []);
+function parseOptions(value) {
+    return arr(value).map((o) => {
+        const raw = asRaw(o);
+        const option = {
+            label: String(raw.label ?? ''),
+            effect: raw.effect ?? 'SHARED',
+        };
+        // Absent means "asks for nothing", and the server omits the key then — so
+        // these are only set when they are real, matching what goes out.
+        const required = arr(raw.required).map(String);
+        const optional = arr(raw.optional).map(String);
+        if (required.length)
+            option.required = required;
+        if (optional.length)
+            option.optional = optional;
+        return option;
+    });
+}
+export function parseDecision(value) {
+    if (!value || typeof value !== 'object')
+        return null;
+    const raw = asRaw(value);
+    return {
+        label: str(raw.label),
+        effect: String(raw.effect ?? 'SHARED'),
+        at: str(raw.at),
+        by: str(raw.by),
+    };
+}
+export function parseAlertResponse(value) {
+    const raw = asRaw(value);
+    const delivered = num(raw.delivered);
+    const deduplicated = raw.deduplicated === true;
+    return {
+        id: String(raw._id ?? raw.id ?? ''),
+        channelId: str(raw.channelId),
+        channelName: str(raw.channelName),
+        status: raw.status ?? 'OPEN',
+        severity: raw.severity ?? 'MEDIUM',
+        customId: str(raw.customId),
+        isAutoClose: raw.isAutoClose === true,
+        responseOptions: parseOptions(raw.responseOptions),
+        delivered,
+        createdAt: str(raw.createdAt),
+        deduplicated,
+        reopened: raw.reopened === true,
+        unregistered: arr(raw.unregistered).map(String),
+        noDevice: num(raw.noDevice),
+        pending: num(raw.pending),
+        message: str(raw.message),
+        actuallyReachedSomeone: deduplicated || delivered > 0,
+        raw,
+    };
+}
+/** A sender's attachments arrive as bare strings; a responder's as objects. */
+export function parseAttachment(value) {
+    if (typeof value === 'string')
+        return { url: value, name: null, type: null, size: null };
+    const raw = asRaw(value);
+    return {
+        url: String(raw.url ?? ''),
+        name: str(raw.name),
+        type: str(raw.type),
+        size: raw.size === undefined || raw.size === null ? null : num(raw.size),
+    };
+}
+export function parseResponse(value) {
+    const raw = asRaw(value);
+    return {
+        label: str(raw.label),
+        effect: String(raw.effect ?? 'PERSONAL'),
+        optionIndex: raw.optionIndex === undefined || raw.optionIndex === null ? null : num(raw.optionIndex),
+        at: str(raw.at),
+        by: str(raw.by),
+        note: str(raw.note),
+        attachments: arr(raw.attachments).map(parseAttachment),
+    };
+}
+export function parseAlertDetail(value) {
+    const raw = asRaw(value);
+    const decision = parseDecision(raw.decision);
+    const status = raw.status ?? 'OPEN';
+    return {
+        id: String(raw._id ?? raw.id ?? ''),
+        customId: str(raw.customId),
+        status,
+        severity: raw.severity ?? 'MEDIUM',
+        title: str(raw.title),
+        isAutoClose: raw.isAutoClose === true,
+        reopenCount: num(raw.reopenCount),
+        responseOptions: parseOptions(raw.responseOptions),
+        responses: arr(raw.responses).map(parseResponse),
+        attachments: arr(raw.attachments).map(parseAttachment),
+        pending: num(raw.pending),
+        decision,
+        resolvedAt: str(raw.resolvedAt),
+        createdAt: str(raw.createdAt),
+        isDecided: decision !== null,
+        isClosed: status === 'RESOLVED',
+        raw,
+    };
+}
+export function parseChannelInfo(value) {
+    const raw = asRaw(value);
+    const channel = asRaw(raw.channel);
+    const sender = asRaw(raw.sender);
+    return {
+        id: String(channel.id ?? ''),
+        name: String(channel.name ?? ''),
+        visibility: String(channel.visibility ?? 'PRIVATE'),
+        senderLabel: str(sender.label),
+        senderId: str(sender.id),
+    };
+}
+export function parseApiKeyInfo(value) {
+    const raw = asRaw(value);
+    const key = asRaw(raw.key);
+    const owner = asRaw(raw.owner);
+    return {
+        keyId: String(key._id ?? key.id ?? ''),
+        prefix: str(key.prefix),
+        label: str(key.label),
+        createdAt: str(key.createdAt),
+        ownerPhone: str(owner.phone),
+    };
+}
+export function parseRecipient(value) {
+    const raw = asRaw(value);
+    const state = raw.state ?? 'pending';
+    return {
+        phone: String(raw.phone ?? ''),
+        state,
+        reachable: raw.reachable === undefined ? state === 'accepted' : raw.reachable === true,
+    };
+}
+export function parseProvisionedChannel(value) {
+    const raw = asRaw(value);
+    return {
+        id: String(raw._id ?? raw.id ?? ''),
+        name: String(raw.name ?? ''),
+        sendLink: str(raw.sendLink),
+    };
+}
+export function parseInviteResult(value) {
+    const raw = asRaw(value);
+    return {
+        invited: arr(raw.invited).map(String),
+        already: arr(raw.already).map(String),
+        pending: arr(raw.pending).map(String),
+        declined: arr(raw.declined).map(String),
+        raw,
+    };
+}
+/** True when this decision is the approval, compared case-insensitively.
+ *
+ * A missing label is not an approval. The server can hand back `label: null`,
+ * and treating an unknown answer as a yes is the wrong way to be wrong about a
+ * payment. */
+export function isApproved(decision, approveLabel = 'Approve') {
+    if (!decision?.label)
+        return false;
+    return collapse(decision.label).toLowerCase() === collapse(approveLabel).toLowerCase();
+}
+// ── outbound ──────────────────────────────────────────────────────────────────
+/**
+ * Trim and collapse runs of whitespace, as `validateRequest` does server-side.
+ * Done here too so a length check measures the string the server will measure.
+ */
+export function collapse(value) {
+    return String(value).replace(/\s+/g, ' ').trim();
+}
+/**
+ * Validate an alert locally and render the JSON body the server accepts.
+ *
+ * Every limit checked here is one the server enforces. Checking twice is not
+ * duplication for its own sake: a 400 costs a round trip, and the caller is
+ * often a cron or an agent that will simply do it again.
+ */
+export function buildAlertPayload(title, fields = {}, maxOptions = MAX_RESPONSE_OPTIONS) {
+    const cleanTitle = collapse(title ?? '');
+    if (!cleanTitle)
+        throw new M91ValidationError('title is required');
+    if (cleanTitle.length < TITLE_MIN) {
+        throw new M91ValidationError(`title must be at least ${TITLE_MIN} characters, got ${cleanTitle.length}`);
+    }
+    if (cleanTitle.length > TITLE_MAX) {
+        throw new M91ValidationError(`title must be ${TITLE_MAX} characters or fewer, got ${cleanTitle.length}`);
+    }
+    const severity = checkSeverity(fields.severity ?? 'MEDIUM');
+    const payload = { title: cleanTitle, severity };
+    if (fields.other !== undefined && fields.other !== null) {
+        payload.other = Boolean(fields.other);
+    }
+    /*
+     * URLs, never bytes.
+     *
+     * The server takes links and not multipart, because every automation a send
+     * link is pasted into — viasocket, Zapier, Make, a spreadsheet — has a URL
+     * field and little else. Checked here so a typo costs nothing: a cron that
+     * gets a 400 will simply send it again.
+     */
+    if (fields.attachments?.length) {
+        const urls = [];
+        for (const item of fields.attachments) {
+            const url = collapse(String(item ?? ''));
+            if (!url)
+                continue;
+            if (url.length > ATTACHMENT_URL_MAX) {
+                throw new M91ValidationError(`attachment URL must be ${ATTACHMENT_URL_MAX} characters or fewer, got ${url.length}`);
+            }
+            if (!/^https:\/\//i.test(url)) {
+                throw new M91ValidationError(`attachment must be an https link, got ${JSON.stringify(url)}`);
+            }
+            urls.push(url);
+        }
+        if (urls.length)
+            payload.attachments = urls;
+    }
+    if (fields.callbackUrl !== undefined && fields.callbackUrl !== null) {
+        const callbackUrl = collapse(fields.callbackUrl);
+        if (callbackUrl.length > CALLBACK_URL_MAX) {
+            throw new M91ValidationError(`callbackUrl must be ${CALLBACK_URL_MAX} characters or fewer, got ${callbackUrl.length}`);
+        }
+        if (callbackUrl)
+            payload.callbackUrl = callbackUrl;
+    }
+    if (fields.description !== undefined && fields.description !== null) {
+        const description = collapse(fields.description);
+        if (description.length > DESCRIPTION_MAX) {
+            throw new M91ValidationError(`description must be ${DESCRIPTION_MAX} characters or fewer, got ${description.length}`);
+        }
+        payload.description = description;
+    }
+    if (fields.customId !== undefined && fields.customId !== null) {
+        const customId = collapse(String(fields.customId));
+        if (!customId)
+            throw new M91ValidationError('customId cannot be empty — omit it instead');
+        if (customId.length > CUSTOM_ID_MAX) {
+            throw new M91ValidationError(`customId must be ${CUSTOM_ID_MAX} characters or fewer, got ${customId.length}`);
+        }
+        payload.customId = customId;
+    }
+    // Always sent, never omitted. The default is false on both sides, but an
+    // explicit false is what lets a code review of the call site tell "stays open
+    // until somebody closes it" from "nobody thought about it".
+    payload.isAutoClose = fields.isAutoClose === true;
+    if (fields.responseOptions !== undefined) {
+        payload.responseOptions = checkOptions(normalizeOptions(fields.responseOptions), maxOptions);
+    }
+    return payload;
+}
+export function normalizeOptions(options) {
+    return options.map((option) => {
+        const raw = typeof option === 'string' ? { label: option } : option;
+        const label = collapse(raw?.label ?? '');
+        if (!label)
+            throw new M91ValidationError('response option label cannot be empty');
+        if (label.length > LABEL_MAX) {
+            throw new M91ValidationError(`response option label must be ${LABEL_MAX} characters or fewer, got ${label.length}: '${label}'`);
+        }
+        const effect = raw.effect ?? 'SHARED';
+        if (!EFFECTS.includes(effect)) {
+            throw new M91ValidationError(`effect must be SHARED or PERSONAL, got '${effect}'`);
+        }
+        const built = { label, effect };
+        const required = collectFields(raw.required, 'required');
+        const optional = collectFields(raw.optional, 'optional');
+        const both = required.filter((f) => optional.includes(f));
+        if (both.length) {
+            // The server takes the stricter of the two, so this is a statement the
+            // sender did not mean. Saying so beats silently picking one.
+            throw new M91ValidationError(`${both.join(', ')} cannot be both required and optional`);
+        }
+        /*
+         * Only what was set. A field in NEITHER list is not rendered at all, which
+         * is what stops an option configured for a photo putting an unwanted note
+         * box in front of somebody at 3am.
+         */
+        if (required.length)
+            built.required = required;
+        if (optional.length)
+            built.optional = optional;
+        return built;
+    });
+}
+/**
+ * Normalise and check a `required` / `optional` list.
+ *
+ * Checked here because the server's enum error — "must be note or
+ * attachment" — arrives after a round trip, and the caller is usually a cron
+ * or an agent that will just send it again.
+ */
+function collectFields(value, which) {
+    if (!value)
+        return [];
+    const items = Array.isArray(value) ? value : [value];
+    const out = [];
+    for (const item of items) {
+        const name = collapse(String(item ?? '')).toLowerCase();
+        if (!COLLECTABLE.includes(name)) {
+            throw new M91ValidationError(`${which} must contain only ${COLLECTABLE.join(' or ')}, got ${JSON.stringify(item)}`);
+        }
+        if (!out.includes(name))
+            out.push(name);
+    }
+    return out;
+}
+function checkOptions(options, maxOptions) {
+    if (options.length > maxOptions) {
+        throw new M91ValidationError(`cannot offer more than ${maxOptions} response options, got ${options.length}`);
+    }
+    const seen = new Set();
+    for (const option of options) {
+        const key = option.label.toLowerCase();
+        // The server rejects this too. Two buttons reading the same thing with
+        // different effects is an alert nobody can answer correctly at 3am.
+        if (seen.has(key)) {
+            throw new M91ValidationError(`cannot repeat the same response label twice: '${option.label}'`);
+        }
+        seen.add(key);
+    }
+    return options;
+}
+export function checkSeverity(severity) {
+    const value = String(severity).toUpperCase();
+    if (!SEVERITIES.includes(value)) {
+        throw new M91ValidationError(`severity must be one of: ${SEVERITIES.join(', ')}, got '${severity}'`);
+    }
+    return value;
+}
+/**
+ * Digits only, 8–15, country code included, no `+` and no spaces.
+ * The `+` is the one everybody gets wrong, so it gets its own message.
+ */
+export function validatePhone(phone) {
+    const raw = String(phone ?? '').trim();
+    if (raw.startsWith('+')) {
+        throw new M91ValidationError(`phone must not start with '+': send digits only, e.g. '${raw.slice(1)}' not '${raw}'`);
+    }
+    if (!PHONE_RE.test(raw)) {
+        throw new M91ValidationError(`phone must be 8-15 digits including the country code, with no '+' or spaces ` +
+            `(e.g. 919876543210), got '${phone}'`);
+    }
+    return raw;
+}
+//# sourceMappingURL=models.js.map

package/dist/src/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAOrD,MAAM,CAAC,MAAM,UAAU,GAAwB,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAU,CAAC;AAC9F,MAAM,CAAC,MAAM,OAAO,GAAsB,CAAC,QAAQ,EAAE,UAAU,CAAU,CAAC;AAE1E,mEAAmE;AACnE,MAAM,CAAC,MAAM,qBAAqB,GAAwB,CAAC,MAAM,EAAE,UAAU,CAAU,CAAC;AAExF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAAC;AAC3B,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,CAAC;AAC9B,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,CAAC;AACpC,MAAM,CAAC,MAAM,aAAa,GAAG,GAAG,CAAC;AACjC,MAAM,CAAC,MAAM,SAAS,GAAG,EAAE,CAAC;AAC5B,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,CAAC;AACvC,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAC9B,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC;AAC3C,MAAM,CAAC,MAAM,gBAAgB,GAAG,EAAE,CAAC;AACnC,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAG,CAAC;AAExC,mFAAmF;AACnF,MAAM,QAAQ,GAAG,YAAY,CAAC;AAE9B,gEAAgE;AAChE,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,MAAM,EAAE,YAAY,CAAU,CAAC;AA2M3D,MAAM,KAAK,GAAG,CAAC,KAAc,EAAO,EAAE,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAE,KAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AAClG,MAAM,GAAG,GAAG,CAAC,KAAc,EAAiB,EAAE,CAAC,CAAC,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AAC9G,MAAM,GAAG,GAAG,CAAC,KAAc,EAAU,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC7F,MAAM,GAAG,GAAG,CAAC,KAAc,EAAa,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AAE/E,SAAS,YAAY,CAAC,KAAc;IAClC,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QAC1B,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACrB,MAAM,MAAM,GAAmB;YAC7B,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC;YAC9B,MAAM,EAAG,GAAG,CAAC,MAAiB,IAAI,QAAQ;SAC3C,CAAC;QACF,0EAA0E;QAC1E,iEAAiE;QACjE,MAAM,QAAQ,GAAG,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,MAAM,CAAkB,CAAC;QAChE,MAAM,QAAQ,GAAG,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,MAAM,CAAkB,CAAC;QAChE,IAAI,QAAQ,CAAC,MAAM;YAAE,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAChD,IAAI,QAAQ,CAAC,MAAM;YAAE,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAChD,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IACrD,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IACzB,OAAO;QACL,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC;QACrB,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,IAAI,QAAQ,CAAC;QACtC,EAAE,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;QACf,EAAE,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;KAChB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,KAAc;IAC/C,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IACzB,MAAM,SAAS,GAAG,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACrC,MAAM,YAAY,GAAG,GAAG,CAAC,YAAY,KAAK,IAAI,CAAC;IAC/C,OAAO;QACL,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC;QACnC,SAAS,EAAE,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC;QAC7B,WAAW,EAAE,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC;QACjC,MAAM,EAAG,GAAG,CAAC,MAAsB,IAAI,MAAM;QAC7C,QAAQ,EAAG,GAAG,CAAC,QAAqB,IAAI,QAAQ;QAChD,QAAQ,EAAE,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC;QAC3B,WAAW,EAAE,GAAG,CAAC,WAAW,KAAK,IAAI;QACrC,eAAe,EAAE,YAAY,CAAC,GAAG,CAAC,eAAe,CAAC;QAClD,SAAS;QACT,SAAS,EAAE,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC;QAC7B,YAAY;QACZ,QAAQ,EAAE,GAAG,CAAC,QAAQ,KAAK,IAAI;QAC/B,YAAY,EAAE,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;QAC/C,QAAQ,EAAE,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC;QAC3B,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC;QACzB,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC;QACzB,sBAAsB,EAAE,YAAY,IAAI,SAAS,GAAG,CAAC;QACrD,GAAG;KACJ,CAAC;AACJ,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,eAAe,CAAC,KAAc;IAC5C,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IACzF,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IACzB,OAAO;QACL,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,CAAC;QAC1B,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC;QACnB,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC;QACnB,IAAI,EAAE,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC;KACzE,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IACzB,OAAO;QACL,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC;QACrB,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,IAAI,UAAU,CAAC;QACxC,WAAW,EAAE,GAAG,CAAC,WAAW,KAAK,SAAS,IAAI,GAAG,CAAC,WAAW,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC;QACpG,EAAE,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;QACf,EAAE,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;QACf,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC;QACnB,WAAW,EAAE,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC;KACvD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IACzB,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAI,GAAG,CAAC,MAAsB,IAAI,MAAM,CAAC;IACrD,OAAO;QACL,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC;QACnC,QAAQ,EAAE,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC;QAC3B,MAAM;QACN,QAAQ,EAAG,GAAG,CAAC,QAAqB,IAAI,QAAQ;QAChD,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC;QACrB,WAAW,EAAE,GAAG,CAAC,WAAW,KAAK,IAAI;QACrC,WAAW,EAAE,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC;QACjC,eAAe,EAAE,YAAY,CAAC,GAAG,CAAC,eAAe,CAAC;QAClD,SAAS,EAAE,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC;QAChD,WAAW,EAAE,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC;QACtD,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC;QACzB,QAAQ;QACR,UAAU,EAAE,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC;QAC/B,SAAS,EAAE,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC;QAC7B,SAAS,EAAE,QAAQ,KAAK,IAAI;QAC5B,QAAQ,EAAE,MAAM,KAAK,UAAU;QAC/B,GAAG;KACJ,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IACzB,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACnC,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACjC,OAAO;QACL,EAAE,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC;QAC5B,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC;QAChC,UAAU,EAAE,MAAM,CAAC,OAAO,CAAC,UAAU,IAAI,SAAS,CAAC;QACnD,WAAW,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC;QAC9B,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;KACzB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,KAAc;IAC5C,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IACzB,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC3B,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC/B,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC;QACtC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC;QACvB,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC;QACrB,SAAS,EAAE,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC;QAC7B,UAAU,EAAE,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC;KAC7B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAc;IAC3C,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IACzB,MAAM,KAAK,GAAI,GAAG,CAAC,KAAwB,IAAI,SAAS,CAAC;IACzD,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC;QAC9B,KAAK;QACL,SAAS,EAAE,GAAG,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,KAAK,IAAI;KACvF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,KAAc;IACpD,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IACzB,OAAO;QACL,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC;QACnC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;QAC5B,QAAQ,EAAE,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC;KAC5B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC9C,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IACzB,OAAO;QACL,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;QACrC,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;QACrC,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;QACrC,QAAQ,EAAE,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;QACvC,GAAG;KACJ,CAAC;AACJ,CAAC;AAED;;;;cAIc;AACd,MAAM,UAAU,UAAU,CAAC,QAAyB,EAAE,YAAY,GAAG,SAAS;IAC5E,IAAI,CAAC,QAAQ,EAAE,KAAK;QAAE,OAAO,KAAK,CAAC;IACnC,OAAO,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,CAAC;AACzF,CAAC;AAED,iFAAiF;AAEjF;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAa;IACpC,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;AACnD,CAAC;AAqBD;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAC/B,KAAa,EACb,SAAsB,EAAE,EACxB,UAAU,GAAG,oBAAoB;IAEjC,MAAM,UAAU,GAAG,QAAQ,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;IACzC,IAAI,CAAC,UAAU;QAAE,MAAM,IAAI,kBAAkB,CAAC,mBAAmB,CAAC,CAAC;IACnE,IAAI,UAAU,CAAC,MAAM,GAAG,SAAS,EAAE,CAAC;QAClC,MAAM,IAAI,kBAAkB,CAC1B,0BAA0B,SAAS,oBAAoB,UAAU,CAAC,MAAM,EAAE,CAC3E,CAAC;IACJ,CAAC;IACD,IAAI,UAAU,CAAC,MAAM,GAAG,SAAS,EAAE,CAAC;QAClC,MAAM,IAAI,kBAAkB,CAC1B,iBAAiB,SAAS,6BAA6B,UAAU,CAAC,MAAM,EAAE,CAC3E,CAAC;IACJ,CAAC;IAED,MAAM,QAAQ,GAAG,aAAa,CAAC,MAAM,CAAC,QAAQ,IAAI,QAAQ,CAAC,CAAC;IAC5D,MAAM,OAAO,GAA4B,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC;IAEzE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;QACxD,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,CAAC;QAC/B,MAAM,IAAI,GAAa,EAAE,CAAC;QAC1B,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;YACtC,MAAM,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;YACzC,IAAI,CAAC,GAAG;gBAAE,SAAS;YACnB,IAAI,GAAG,CAAC,MAAM,GAAG,kBAAkB,EAAE,CAAC;gBACpC,MAAM,IAAI,kBAAkB,CAC1B,0BAA0B,kBAAkB,6BAA6B,GAAG,CAAC,MAAM,EAAE,CACtF,CAAC;YACJ,CAAC;YACD,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC9B,MAAM,IAAI,kBAAkB,CAC1B,yCAAyC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAC/D,CAAC;YACJ,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjB,CAAC;QACD,IAAI,IAAI,CAAC,MAAM;YAAE,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAC9C,CAAC;IAED,IAAI,MAAM,CAAC,WAAW,KAAK,SAAS,IAAI,MAAM,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;QACpE,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACjD,IAAI,WAAW,CAAC,MAAM,GAAG,gBAAgB,EAAE,CAAC;YAC1C,MAAM,IAAI,kBAAkB,CAC1B,uBAAuB,gBAAgB,6BAA6B,WAAW,CAAC,MAAM,EAAE,CACzF,CAAC;QACJ,CAAC;QACD,IAAI,WAAW;YAAE,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;IACrD,CAAC;IAED,IAAI,MAAM,CAAC,WAAW,KAAK,SAAS,IAAI,MAAM,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;QACpE,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACjD,IAAI,WAAW,CAAC,MAAM,GAAG,eAAe,EAAE,CAAC;YACzC,MAAM,IAAI,kBAAkB,CAC1B,uBAAuB,eAAe,6BAA6B,WAAW,CAAC,MAAM,EAAE,CACxF,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;IACpC,CAAC;IAED,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,IAAI,MAAM,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;QAC9D,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;QACnD,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,kBAAkB,CAAC,4CAA4C,CAAC,CAAC;QAC1F,IAAI,QAAQ,CAAC,MAAM,GAAG,aAAa,EAAE,CAAC;YACpC,MAAM,IAAI,kBAAkB,CAC1B,oBAAoB,aAAa,6BAA6B,QAAQ,CAAC,MAAM,EAAE,CAChF,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC9B,CAAC;IAED,yEAAyE;IACzE,8EAA8E;IAC9E,4DAA4D;IAC5D,OAAO,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,KAAK,IAAI,CAAC;IAElD,IAAI,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;QACzC,OAAO,CAAC,eAAe,GAAG,YAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,UAAU,CAAC,CAAC;IAC/F,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,OAAuC;IACtE,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QAC5B,MAAM,GAAG,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;QACpE,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC;QACzC,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,kBAAkB,CAAC,uCAAuC,CAAC,CAAC;QAClF,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS,EAAE,CAAC;YAC7B,MAAM,IAAI,kBAAkB,CAC1B,iCAAiC,SAAS,6BAA6B,KAAK,CAAC,MAAM,MAAM,KAAK,GAAG,CAClG,CAAC;QACJ,CAAC;QACD,MAAM,MAAM,GAAI,GAAsB,CAAC,MAAM,IAAI,QAAQ,CAAC;QAC1D,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,kBAAkB,CAAC,2CAA2C,MAAM,GAAG,CAAC,CAAC;QACrF,CAAC;QAED,MAAM,KAAK,GAAmB,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAChD,MAAM,QAAQ,GAAG,aAAa,CAAE,GAAsB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAC7E,MAAM,QAAQ,GAAG,aAAa,CAAE,GAAsB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAC7E,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1D,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,uEAAuE;YACvE,6DAA6D;YAC7D,MAAM,IAAI,kBAAkB,CAC1B,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,uCAAuC,CAC1D,CAAC;QACJ,CAAC;QAED;;;;WAIG;QACH,IAAI,QAAQ,CAAC,MAAM;YAAE,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC/C,IAAI,QAAQ,CAAC,MAAM;YAAE,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC/C,OAAO,KAAK,CAAC;IACf,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAS,aAAa,CAAC,KAAc,EAAE,KAAa;IAClD,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,CAAC;IACtB,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACrD,MAAM,GAAG,GAAkB,EAAE,CAAC;IAC9B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,WAAW,EAAiB,CAAC;QACvE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,kBAAkB,CAC1B,GAAG,KAAK,sBAAsB,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CACtF,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,YAAY,CAAC,OAAyB,EAAE,UAAkB;IACjE,IAAI,OAAO,CAAC,MAAM,GAAG,UAAU,EAAE,CAAC;QAChC,MAAM,IAAI,kBAAkB,CAC1B,0BAA0B,UAAU,0BAA0B,OAAO,CAAC,MAAM,EAAE,CAC/E,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QACvC,uEAAuE;QACvE,oEAAoE;QACpE,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAClB,MAAM,IAAI,kBAAkB,CAAC,iDAAiD,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC;QACjG,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChB,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,QAAgB;IAC5C,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAc,CAAC;IACzD,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,kBAAkB,CAAC,4BAA4B,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,QAAQ,GAAG,CAAC,CAAC;IACvG,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,KAAa;IACzC,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACvC,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,kBAAkB,CAC1B,0DAA0D,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,GAAG,GAAG,CACvF,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,kBAAkB,CAC1B,8EAA8E;YAC5E,6BAA6B,KAAK,GAAG,CACxC,CAAC;IACJ,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/src/platform.d.ts

@@ -0,0 +1,176 @@
+/**
+ * The API-key client: alerting **one person, by phone number**.
+ *
+ * The narrowness is the point, and worth understanding before reaching for
+ * this. A team is already solved — somebody creates the channel in the app and
+ * the integration posts to its send link. What a link cannot do is address a
+ * person a platform is discovering at runtime: a CRM signing up its
+ * five-thousandth salesman cannot mint and store five thousand bearer
+ * credentials, each able to wake somebody through Do Not Disturb, sitting in a
+ * user table with no rotation. So for one person, the secret is one header and
+ * the address is a phone number.
+ *
+ * **An API key cannot alert a team channel.** It can *provision* one — create
+ * it, staff it, read its send link — because that is the same authority its
+ * owner has in the app. Raising the alert is still the send link's job. A
+ * leaked key can rename or restaff a channel; it cannot ring a single phone in
+ * it, and that split is the entire reason the two capabilities sit on two
+ * credentials.
+ */
+import { type TransportOptions } from './http.js';
+import { type AlertDetail, type AlertResponse, type ApiKeyInfo, type InviteResult, type ProvisionedChannel, type Recipient } from './models.js';
+import { type SendOptions } from './client.js';
+export declare const DEFAULT_BASE_URL = "https://m91-api.msg91.com";
+export declare const API_KEY_PREFIX = "m91sk_";
+export interface PlatformOptions extends TransportOptions {
+    baseUrl?: string;
+    /**
+     * Throw `M91DeliveryError` when an alert reaches nobody. On by default, for
+     * the same reason as on `M91Client` — and it bites harder here. A direct
+     * alert has a roster of exactly one, so one stale device token is the
+     * difference between waking somebody and waking nobody, and the API still
+     * answers 201.
+     */
+    throwOnZeroDelivery?: boolean;
+}
+/** Invite people, alert them one at a time, and provision team channels. */
+export declare class M91Platform {
+    readonly baseUrl: string;
+    readonly throwOnZeroDelivery: boolean;
+    private readonly apiKey;
+    private readonly http;
+    constructor(apiKey: string, options?: PlatformOptions);
+    /** The key is a live credential that can wake people. Only its prefix. */
+    toString(): string;
+    private url;
+    /**
+     * Check the key works, and see which key it is. **Alerts nobody.**
+     *
+     * The only route on this surface that is safe to call just to find out
+     * whether a credential works — everything else writes something or needs an
+     * id that already exists. On an alerting product, "test the connection" must
+     * never mean "wake somebody", so do not verify a key by sending an alert.
+     *
+     * A revoked key never reaches this route, so a success means *live*, not
+     * merely well-formed.
+     *
+     * Note what it does **not** prove: a perfectly good key with nobody accepted
+     * behind it still alerts nobody. Invite a real number and check the state
+     * before you believe the integration works.
+     */
+    verify(): Promise<ApiKeyInfo>;
+    /**
+     * Invite somebody to accept direct alerts. **Idempotent.**
+     *
+     * Keyed on the phone number, so calling it on every login is safe and is the
+     * intended usage — retries cannot produce a second channel.
+     *
+     * The returned `state` needs different handling in each case, and the
+     * important one is that only `accepted` can actually be woken. A `pending`
+     * recipient has been asked and has not answered: nag them in your own UI, do
+     * not re-invite them in a loop. `declined` is terminal — no API re-invites a
+     * declined number, and only they can undo it from their own app.
+     *
+     * Inviting is deliberately separate from alerting: **an alert must never be
+     * what invites somebody**, because an invited person is not an M91 user yet
+     * and the urgent thing would arrive as an ordinary message that does not
+     * pierce Do Not Disturb, does not repeat and does not escalate.
+     *
+     * `label` is **the name the person sees on the alert**, not a name for the
+     * person. It is the only thing on their screen saying where the alert came
+     * from, so it should be your product — "Acme CRM", not "Priya" and not an id.
+     * Woken at 3am, "Acme CRM" answers the question they have and their own name
+     * does not.
+     *
+     * Two things follow, and both bite: it defaults to `"Direct alerts"` when
+     * omitted, and **every invite overwrites it**. Since this call belongs in
+     * your login handler, omitting the label on the second login resets a good
+     * name back to the default. Pass the same constant every time.
+     */
+    inviteRecipient(phone: string, label?: string): Promise<Recipient>;
+    /**
+     * Stop alerting somebody. `true` when they are no longer a recipient.
+     *
+     * Worth wiring to whatever your system calls offboarding. Nothing in an
+     * integration is as routinely forgotten, and forgetting it means somebody who
+     * left the company is still woken at 3am.
+     */
+    removeRecipient(phone: string): Promise<boolean>;
+    /**
+     * Wake one person. They must have been invited **and have accepted**.
+     *
+     * Alerting a number nobody invited throws `M91NotFoundError`, never a silent
+     * invitation.
+     *
+     * A direct alert *is* a channel with one member, so responses, escalation,
+     * deduplication and the consent gate behave exactly as they do for a team —
+     * there is no second implementation to keep in step.
+     */
+    alertPerson(phone: string, title: string, options?: SendOptions): Promise<AlertResponse>;
+    /**
+     * Read back what one person decided. `null` if there is no such alert.
+     * `alertId` is the `customId` you invented or the `_id` a send returned.
+     */
+    getAlert(alertId: string, phone: string): Promise<AlertDetail | null>;
+    /**
+     * Close one person's alert.
+     *
+     * **404 and 403 are success**, as on the send link: "no such alert" and
+     * "already resolved" both mean it is not open, which is what was asked for.
+     */
+    closeAlert(phone: string, options: {
+        customId?: string;
+        alertId?: string;
+    }): Promise<boolean>;
+    /**
+     * Create a team channel and get back the send link that alerts it.
+     *
+     * **Not idempotent, and deliberately takes no id of your own to make it so.**
+     * Calling this twice makes two channels. Store the returned `id` and
+     * `sendLink` against your own team the moment you get them — a lost response
+     * is an orphaned channel, not something to retry.
+     *
+     * `alertOwner: false` skips adding the key's owner as a member: a platform
+     * minting one channel per customer team has no reason for its own account to
+     * be paged for every one of them. They stay the owner either way.
+     */
+    /**
+     * Every team channel this key can raise an alert on.
+     *
+     * The missing half of {@link createChannel}, which is **not idempotent**: a
+     * platform that lost the response to a create had an orphaned channel and no
+     * way to find it. Now it can read back what it already has.
+     *
+     * **Scoped by send access, not by ownership.** Every row carries a
+     * `sendLink`, so the list answers "what can I alert?" — which includes a
+     * channel whose owner granted this person send access, not only the ones they
+     * created. Creating a channel grants its owner send access too, so owned
+     * channels are a subset of this rather than a separate case.
+     *
+     * Channels they merely joined stay absent: being a member means you get
+     * woken, not that you may wake others. Archived channels are left out, since
+     * a link that cannot alert anybody is worse than no link.
+     */
+    listChannels(): Promise<ProvisionedChannel[]>;
+    createChannel(name: string, alertOwner?: boolean): Promise<ProvisionedChannel>;
+    /**
+     * Invite people into a team channel. Up to 500 per call.
+     *
+     * Adding somebody to the roster is not the same as being able to alert them:
+     * they are invited, and an invitation is theirs to accept.
+     */
+    addMembers(channelId: string, phones: string[]): Promise<InviteResult>;
+    /** Take somebody off a team channel's roster. */
+    removeMember(channelId: string, phone: string): Promise<boolean>;
+    /** Already-not-there is the state the caller asked for. */
+    private tolerateMissing;
+}
+/**
+ * An API key is told apart from a mobile JWT by its prefix, server-side. So a
+ * key without it never reaches the key verifier at all, and comes back as a
+ * bare 401 that looks like revocation. Checked here to say what is actually
+ * wrong.
+ */
+export declare function checkApiKey(apiKey: string): string;
+export declare function checkPhones(phones: string[]): string[];
+//# sourceMappingURL=platform.d.ts.map

package/dist/src/platform.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"platform.d.ts","sourceRoot":"","sources":["../../src/platform.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAGH,OAAO,EAAa,KAAK,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7D,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,aAAa,EAClB,KAAK,UAAU,EAEf,KAAK,YAAY,EAEjB,KAAK,kBAAkB,EACvB,KAAK,SAAS,EAUf,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,KAAK,WAAW,EAAiB,MAAM,aAAa,CAAC;AAE9D,eAAO,MAAM,gBAAgB,8BAA8B,CAAC;AAC5D,eAAO,MAAM,cAAc,WAAW,CAAC;AAEvC,MAAM,WAAW,eAAgB,SAAQ,gBAAgB;IACvD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,4EAA4E;AAC5E,qBAAa,WAAW;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,mBAAmB,EAAE,OAAO,CAAC;IACtC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAY;gBAErB,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,eAAoB;IAUzD,0EAA0E;IAC1E,QAAQ,IAAI,MAAM;IAIlB,OAAO,CAAC,GAAG;IAIX;;;;;;;;;;;;;;OAcG;IACG,MAAM,IAAI,OAAO,CAAC,UAAU,CAAC;IAInC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAMxE;;;;;;OAMG;IACG,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAOtD;;;;;;;;;OASG;IACG,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,aAAa,CAAC;IAclG;;;OAGG;IACG,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAc3E;;;;;OAKG;IACG,UAAU,CACd,KAAK,EAAE,MAAM,EACb,OAAO,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAC/C,OAAO,CAAC,OAAO,CAAC;IAwBnB;;;;;;;;;;;OAWG;IACH;;;;;;;;;;;;;;;;OAgBG;IACG,YAAY,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAK7C,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,UAAO,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAiBjF;;;;;OAKG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC;IAU5E,iDAAiD;IAC3C,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAStE,2DAA2D;YAC7C,eAAe;CAS9B;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAUlD;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAStD"}