@objectstack/service-sms 14.5.0

package/.turbo/turbo-build.log

@@ -0,0 +1,22 @@
+
+> @objectstack/service-sms@14.5.0 build /home/runner/work/framework/framework/packages/services/service-sms
+> tsup --config ../../../tsup.config.ts
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.5.1
+CLI Using tsup config: /home/runner/work/framework/framework/tsup.config.ts
+CLI Target: es2020
+CLI Cleaning output folder
+ESM Build start
+CJS Build start
+CJS dist/index.js     17.13 KB
+CJS dist/index.js.map 36.45 KB
+CJS ⚡️ Build success in 149ms
+ESM dist/index.mjs     15.76 KB
+ESM dist/index.mjs.map 35.83 KB
+ESM ⚡️ Build success in 153ms
+DTS Build start
+DTS ⚡️ Build success in 14830ms
+DTS dist/index.d.mts 8.12 KB
+DTS dist/index.d.ts  8.12 KB

package/CHANGELOG.md

@@ -0,0 +1,78 @@
+# @objectstack/service-sms
+
+## 14.5.0
+
+### Patch Changes
+
+- Updated dependencies [526805e]
+- Updated dependencies [d79ca07]
+- Updated dependencies [33ebd34]
+- Updated dependencies [c044f08]
+- Updated dependencies [01274eb]
+  - @objectstack/spec@14.5.0
+  - @objectstack/core@14.5.0
+
+## 14.4.0
+
+### Patch Changes
+
+- 1c19139: refactor(sms): rename `@objectstack/plugin-sms` to `@objectstack/service-sms`
+
+  Infrastructure services follow the `service-*` convention
+  (`service-messaging`, `service-settings`, …) — the `plugin-*` prefix was a
+  misfit for a package whose whole job is registering the `sms` kernel
+  service (`plugin-email` is legacy debt, not precedent). Same exports, same
+  `SmsServicePlugin` class, same `sms` service id and settings namespace —
+  only the package name and its home (`packages/services/service-sms`)
+  change. The one published `@objectstack/plugin-sms@14.3.0` release should
+  be npm-deprecated in favour of `@objectstack/service-sms`.
+
+- Updated dependencies [7953832]
+- Updated dependencies [82e745e]
+- Updated dependencies [f3035bd]
+- Updated dependencies [82c0d94]
+- Updated dependencies [7449476]
+  - @objectstack/spec@14.4.0
+  - @objectstack/core@14.4.0
+
+## 14.3.0
+
+### Minor Changes
+
+- c1064f1: feat(messaging/auth): SMS infrastructure + phone-number OTP first-login/reset (#2780)
+
+  #2766 shipped phone+password sign-in but no OTP — the platform had no SMS
+  delivery capability. This adds the missing infrastructure end to end:
+
+  - **New `@objectstack/service-sms`** — `ISmsService`/`ISmsTransport` contracts
+    (spec) with Aliyun SMS (ACS3-HMAC-SHA256, template-based) and Twilio
+    transports plus a dev log fallback. Configured through the new `sms`
+    settings namespace (live provider rebind, encrypted secrets, send-test
+    action; `OS_SMS_*` env keys win at the resolver). Deliberately NO message
+    persistence and NO body logging — SMS bodies carry OTP codes.
+  - **Messaging `sms` channel** — registered at kernel:ready when an `sms`
+    service is present; `notify(channels:['sms'])` resolves
+    `sys_user.phone_number`, renders `(topic,'sms',locale)` templates, and
+    inherits outbox retry/dead-letter.
+  - **Phone OTP flows open** — the phoneNumber plugin's `sendOTP` /
+    `sendPasswordResetOTP` now deliver via SMS, enabling
+    `/phone-number/send-otp` + `/verify` (OTP sign-in/verification) and
+    `/phone-number/request-password-reset` + `/reset-password` (self-service
+    reset). Without a deliverable SMS service they keep failing loudly
+    (NOT_SUPPORTED); `features.phoneNumberOtp` advertises real availability.
+    Shipped with the abuse hardening: explicit `allowedAttempts: 3`, always-on
+    per-number cooldown (60s) + rolling-hour cap (5, secondaryStorage-shared
+    across nodes), `/phone-number/*` in the settings-bound per-IP rate-limit
+    rules, and OTP codes never reach logs or error messages.
+  - **Import SMS invites** — `/admin/import-users`'s `invite` policy now
+    supports phone-only rows: a credential-free invitation SMS points the
+    employee at phone-OTP first sign-in followed by self-set password; mixed
+    files validate the reachable channel per row.
+
+### Patch Changes
+
+- Updated dependencies [2a71f48]
+- Updated dependencies [02f6af4]
+- Updated dependencies [c1064f1]
+  - @objectstack/spec@14.3.0
+  - @objectstack/core@14.3.0

package/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute
+          must include a readable copy of the attribution notices
+          contained within such NOTICE file, excluding those notices
+          that do not pertain to any part of the Derivative Works,
+          in at least one of the following places: within a NOTICE
+          text file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with
+          the Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or as an addendum to
+          the NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the
+          License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 ObjectStack
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/index.d.mts

@@ -0,0 +1,198 @@
+import { ISmsTransport, NormalizedSmsMessage, SmsTransportSendResult, ISmsService, SendSmsInput, SendSmsResult } from '@objectstack/spec/contracts';
+import { Plugin, PluginContext } from '@objectstack/core';
+
+/**
+ * Normalize + validate a recipient phone number. Accepts E.164 and common
+ * human formats (spaces / dashes / dots / parens are stripped). Returns
+ * `undefined` when the result doesn't look like a phone number.
+ *
+ * Same shape rule as plugin-auth's `normalizePhoneNumber` — 6-15 digits
+ * with an optional leading `+` (kept local: the two packages must not
+ * depend on each other).
+ */
+declare function normalizeSmsRecipient(raw: string): string | undefined;
+/**
+ * Mask a phone number for log lines: keep the prefix (country-code-ish) and
+ * the last two digits, hide the middle. `+8613812345678` → `+8613******78`.
+ * SMS logging policy: masked recipient + status ONLY — never the body
+ * (OTP codes travel in it; see the ISmsService contract header).
+ */
+declare function maskPhoneNumber(phone: string): string;
+/**
+ * Development transport — never actually sends. Logs the masked recipient
+ * (and, OUTSIDE production only, the message body so local OTP flows are
+ * testable) and returns a synthetic message id.
+ *
+ * The production-body suppression is a hard rule from #2780: OTP codes must
+ * never land in logs. In dev the body IS the delivery — same pattern as the
+ * auth magic-link / invitation URLs, which are printed in dev only.
+ */
+declare class LogSmsTransport implements ISmsTransport {
+    private readonly logger?;
+    private counter;
+    constructor(logger?: {
+        info: (msg: string, meta?: any) => void;
+    } | undefined);
+    send(message: NormalizedSmsMessage): Promise<SmsTransportSendResult>;
+}
+interface SmsServiceOptions {
+    transport: ISmsTransport;
+    /**
+     * Whether `transport` is a real provider (Aliyun / Twilio / injected).
+     * `false` = development log fallback; surfaced via `isConfigured()` so
+     * consumers can gate SMS-dependent features in production.
+     */
+    configured: boolean;
+    /** Retry attempts on transport throw. Default 0 (no retry). */
+    retries?: number;
+    /** Logger for diagnostic output. NEVER receives message bodies. */
+    logger?: {
+        info: (msg: string, meta?: any) => void;
+        warn: (msg: string, meta?: any) => void;
+    };
+}
+/**
+ * Concrete ISmsService implementation.
+ *
+ * Flow: validate + normalize input → transport.send() (with optional
+ * retry) → SendSmsResult. Deliberately NO persistence and NO body logging —
+ * see the contract header in `@objectstack/spec/contracts/sms-service.ts`.
+ */
+declare class SmsService implements ISmsService {
+    options: SmsServiceOptions;
+    constructor(options: SmsServiceOptions);
+    /**
+     * Hot-swap the underlying transport (settings namespace changed). The
+     * `configured` flag travels with the transport.
+     */
+    setTransport(transport: ISmsTransport, configured: boolean): void;
+    isConfigured(): boolean;
+    send(input: SendSmsInput): Promise<SendSmsResult>;
+}
+
+interface AliyunSmsTransportOptions {
+    accessKeyId: string;
+    accessKeySecret: string;
+    /** 短信签名 SignName — the registered sender signature, e.g. `阿里云短信测试`. */
+    signName: string;
+    /**
+     * Default 模板 TemplateCode used when the input carries no `templateId`
+     * (Aliyun only delivers pre-registered templates — free-form bodies are
+     * refused by the API). A catch-all template with a single `${content}`
+     * variable makes generic notification sends possible.
+     */
+    defaultTemplateCode?: string;
+    /** API endpoint host. Default `dysmsapi.aliyuncs.com`. */
+    endpoint?: string;
+    /** Injectable fetch for tests. */
+    fetchImpl?: typeof fetch;
+}
+/**
+ * Aliyun SMS (dysmsapi `SendSms`) transport, signed with the current
+ * ACS3-HMAC-SHA256 scheme — plain `fetch` + `node:crypto`, no vendor SDK.
+ *
+ * Aliyun is template-only: the transport sends `templateId` (falling back to
+ * the configured default TemplateCode) with `templateParams` (falling back to
+ * `{ content: body }` for the catch-all-template pattern). The rendered
+ * `body` itself is never transmitted outside `TemplateParam`.
+ */
+declare class AliyunSmsTransport implements ISmsTransport {
+    private readonly options;
+    private readonly endpoint;
+    private readonly fetchImpl;
+    constructor(options: AliyunSmsTransportOptions);
+    send(message: NormalizedSmsMessage): Promise<SmsTransportSendResult>;
+}
+
+interface TwilioSmsTransportOptions {
+    accountSid: string;
+    authToken: string;
+    /** Sender number (E.164). One of `from` / `messagingServiceSid` is required. */
+    from?: string;
+    /** Twilio Messaging Service SID (alternative to a fixed `from` number). */
+    messagingServiceSid?: string;
+    /** API base URL override (tests). Default `https://api.twilio.com`. */
+    baseUrl?: string;
+    /** Injectable fetch for tests. */
+    fetchImpl?: typeof fetch;
+}
+/**
+ * Twilio Programmable Messaging transport — a single `POST
+ * /2010-04-01/Accounts/{sid}/Messages.json` with HTTP Basic auth. Plain
+ * `fetch`, no vendor SDK. Free-form: delivers `body` verbatim.
+ */
+declare class TwilioSmsTransport implements ISmsTransport {
+    private readonly options;
+    private readonly baseUrl;
+    private readonly fetchImpl;
+    constructor(options: TwilioSmsTransportOptions);
+    send(message: NormalizedSmsMessage): Promise<SmsTransportSendResult>;
+}
+
+type SmsProviderTag = 'log' | 'aliyun' | 'twilio';
+interface MakeSmsTransportOptions {
+    provider: SmsProviderTag;
+    /** Provider-specific credentials/options (see the transport option types). */
+    options?: Record<string, unknown>;
+    logger?: {
+        info: (msg: string, meta?: any) => void;
+    };
+}
+/**
+ * Build an ISmsTransport from a provider tag + opts. Used by
+ * SmsServicePlugin to materialise the transport selected by config /
+ * the `sms` settings namespace.
+ *
+ * Throws when a non-`log` provider is missing required credentials.
+ */
+declare function makeSmsTransport(opts: MakeSmsTransportOptions): ISmsTransport;
+
+/**
+ * Plugin configuration. Mirrors EmailServicePluginOptions: a directly
+ * injected transport wins, then `provider` + credentials, then the
+ * development `LogSmsTransport` fallback (no real send).
+ */
+interface SmsServicePluginOptions {
+    /** Pluggable delivery transport. Overrides `provider`/credentials. */
+    transport?: ISmsTransport;
+    /** Provider tag — `'log' | 'aliyun' | 'twilio'`. Default `'log'`. */
+    provider?: SmsProviderTag;
+    /** Provider-specific credentials/options (see transport option types). */
+    providerOptions?: Record<string, unknown>;
+    /** Retry attempts on transport throw. Default 0. */
+    retries?: number;
+}
+/**
+ * SmsServicePlugin — registers the `sms` service (#2780).
+ *
+ * Lifecycle:
+ *   - `init`: build transport (injected → provider+credentials →
+ *     LogSmsTransport fallback); register the SmsService so dependents
+ *     (auth OTP, the messaging `sms` channel) can resolve it.
+ *   - `start` (kernel:ready): bind the `sms` settings namespace so the
+ *     admin UI can live-swap the provider without a restart, and register
+ *     the `sms/test` action. Env-locked keys (OS_SMS_*) still win at the
+ *     settings-resolver level.
+ *
+ * Deliberately NO persistence objects: SMS bodies carry OTP codes — see the
+ * ISmsService contract header.
+ */
+declare class SmsServicePlugin implements Plugin {
+    name: string;
+    version: string;
+    type: "standard";
+    private readonly options;
+    private service?;
+    constructor(options?: SmsServicePluginOptions);
+    private resolveInitialTransport;
+    init(ctx: PluginContext): Promise<void>;
+    start(ctx: PluginContext): Promise<void>;
+    /**
+     * Translate the `sms` settings snapshot into a transport and hot-swap it
+     * on the running SmsService. Incomplete credentials keep the previous
+     * transport (with a warning) so a half-saved form can't break delivery.
+     */
+    private applySmsSettings;
+}
+
+export { AliyunSmsTransport, type AliyunSmsTransportOptions, LogSmsTransport, type MakeSmsTransportOptions, type SmsProviderTag, SmsService, type SmsServiceOptions, SmsServicePlugin, type SmsServicePluginOptions, TwilioSmsTransport, type TwilioSmsTransportOptions, makeSmsTransport, maskPhoneNumber, normalizeSmsRecipient };