@seliseblocks/client 0.1.1 → 0.1.3

package/README.md

@@ -1,161 +1,216 @@
-# Blocks Client
-
-Framework-neutral TypeScript SDK for SELISE Blocks frontend and app-runtime code.
-
-`@seliseblocks/client` gives consumer apps a small, typed wrapper around the Blocks APIs they normally call at runtime: Auth/IAM, Data, Localization, and shared HTTP configuration. Detailed `what / why / how` descriptions are kept on the SDK functions themselves so editors and generated typings show the guidance where developers use the API.
-
-Admin/control-plane work belongs in `@seliseblocks/cli-os`: project setup, schema/rules deploy, release deploy, and AI/admin terminal workflows.
-
-For AI agents and automation, see [AI_USAGE_GUIDE.md](AI_USAGE_GUIDE.md).
-
-## Install
-
-```bash
-npm install @seliseblocks/client
-```
-
-Requires Node.js 20+ or a browser/runtime with `fetch`.
-
-## Create A Client
-
-```ts
-import { createBlocksClient } from "@seliseblocks/client";
-
-const blocks = createBlocksClient({
-  apiUrl: "https://api.seliseblocks.com",
-  xBlocksKey: "<blocks-key>",
-  accessToken: () => currentUserSession?.accessToken,
-  oidc: {
-    url: "https://iam.seliseblocks.com",
-    clientId: "<public-browser-client-id>",
-    redirectUri: configuredRedirectUri ?? `${window.location.origin}/login/callback`
-  }
-});
-```
-
-`xBlocksKey` is always sent as the `x-blocks-key` header. Do not send `ProjectKey` or `projectKey` in request query/body payloads.
-
-The SDK does not store tokens. Your app owns login state, refresh scheduling, storage, and logout cleanup.
-
-Use a configured OIDC redirect URI when your app has one. The current-origin `/login/callback` URL is only a browser fallback.
-
-## Auth
-
-Auth has two login flows.
-
-OIDC/hosted IAM login uses `auth.idp`. The SDK relies on Blocks IAM `IdpController`, sends the configured public `clientId`, and does not manually build `oidc/authorize` URLs. Refresh OIDC sessions with `auth.oidc.refreshToken()`, which calls `/iam/v4/oidc/token` and sends `client_id`.
-
-```ts
-await blocks.auth.idp.redirectToProvider();
-
-const result = await blocks.auth.idp.callback(window.location.href);
-
-const refreshed = await blocks.auth.oidc.refreshToken({
-  refreshToken: result.refresh_token,
-  clientId: "<public-browser-client-id>"
-});
-```
-
-Embedded/app-owned login UI uses AuthController methods directly on `auth`: `auth.login()`, `auth.socialInitiate()`, `auth.socialCallback()`, and `auth.refresh()`.
-
-```ts
-const login = await blocks.auth.login({
-  username: "user@example.com",
-  password: "password"
-});
-
-const refreshed = await blocks.auth.refresh({
-  refreshToken: login.refresh_token
-});
-```
-
-Other auth APIs, such as user info, organization switch, logout, signup, recovery, activation, auth config, user codes, client credentials, and identity providers, can be used by either flow when the app has the required token/permission.
-
-`auth.oidc.clientCredentials()` is for trusted non-browser runtimes only because it requires a client secret.
-
-## Common Runtime Calls
-
-```ts
-const me = await blocks.iam.me();
-const orgs = await blocks.iam.organizations.my();
-const features = await blocks.iam.resources.features();
-```
-
-```ts
-const schemas = await blocks.data.schemas.list();
-const schemaInfo = await blocks.data.schemas.infoByName("Student");
-const schemaRules = await blocks.data.validations.bySchemaId("schema-id");
-
-const students = blocks.data.collection("Students");
-const rows = await students.list({ pageNo: 1, pageSize: 20 });
-await students.create({ firstName: "Test" });
-
-const graph = await blocks.data.graphql({
-  query: "{ students { items { itemId firstName } } }"
-});
-```
-
-```ts
-const upload = await blocks.data.files.presignedUploadUrl({
-  name: "avatar.png",
-  configurationName: "default",
-  parentDirectoryId: "root",
-  accessModifier: "Private"
-});
-
-await blocks.data.files.uploadToUrl({
-  url: upload.uploadUrl,
-  body: file,
-  contentType: file.type
-});
-
-const items = await blocks.data.dms.list({
-  configurationName: "default",
-  parentId: "root",
-  skip: 0,
-  take: 20
-});
-```
-
-```ts
-await blocks.localization.load("en-US", ["common", "dashboard"]);
-const label = blocks.localization.t("dashboard.title", "Dashboard");
-
-const tenantLanguages = await blocks.localization.languagesForCurrentTenant();
-const selectedKeys = await blocks.localization.keysByNames({
-  keyNames: ["dashboard.title"]
-});
-```
-
-## API Surface
-
-- `blocks.auth`: AuthController login, social login, refresh, org switch, logout, signup, recovery, activation, auth config, user codes, client credentials, identity providers.
-- `blocks.auth.idp`: hosted IdP initiate, browser redirect, callback, UI config.
-- `blocks.auth.oidc`: refresh-token and client-credentials token endpoint helpers.
-- `blocks.iam`: current user, users, roles, permissions, resources, organizations, signup settings.
-- `blocks.data`: schema reads, validation reads, GraphQL gateway execution, file/storage helpers, DMS file/folder helpers, runtime collection CRUD.
-- `blocks.localization`: tenant language/module discovery, UILM dictionary loading, selected key lookup, simple `t()` lookup.
-
-Professional class names are exported for advanced typing and adapters: `BlocksAuthenticationClient`, `BlocksIAMClient`, `BlocksDataClient`, and `BlocksLocalizationClient`.
-
-## Boundaries
-
-This package must not contain:
-
-- CLI client secrets
-- impersonation APIs
-- project create/list/use
-- schema/rules deploy
-- release deploy
-- token/session/PKCE storage
-- Node filesystem or OS credential storage
-- framework UI components
-- Localization authoring/admin endpoints
-- Data schema/rules mutation endpoints
-
-## Package Checks
-
-```bash
-npm test
-npm pack --dry-run
-```
+# Blocks Client
+
+Framework-neutral TypeScript SDK for SELISE Blocks frontend and app-runtime code.
+
+`@seliseblocks/client` gives consumer apps a small, typed wrapper around the Blocks APIs they normally call at runtime: Auth/IAM, Data, Localization, and shared HTTP configuration. Detailed `what / why / how` descriptions are kept on the SDK functions themselves so editors and generated typings show the guidance where developers use the API.
+
+Admin/control-plane work belongs in `@seliseblocks/cli-os`: project setup, schema/rules deploy, release deploy, and AI/admin terminal workflows.
+
+For AI agents and automation, see [AI_USAGE_GUIDE.md](AI_USAGE_GUIDE.md).
+
+## Install
+
+```bash
+npm install @seliseblocks/client
+```
+
+Requires Node.js 20+ or a browser/runtime with `fetch`.
+
+## Create A Client
+
+```ts
+import { createBlocksClient } from "@seliseblocks/client";
+
+const blocks = createBlocksClient({
+  apiUrl: "https://api.seliseblocks.com",
+  xBlocksKey: "<blocks-key>",
+  accessToken: () => currentUserSession?.accessToken,
+  oidc: {
+    url: "https://iam.seliseblocks.com",
+    clientId: "<public-browser-client-id>",
+    redirectUri: configuredRedirectUri ?? `${window.location.origin}/login/callback`
+  }
+});
+```
+
+`xBlocksKey` is always sent as the `x-blocks-key` header. Do not send `ProjectKey` or `projectKey` in request query/body payloads.
+
+The SDK does not store tokens. Your app owns login state, refresh scheduling, storage, and logout cleanup.
+
+Use a configured OIDC redirect URI when your app has one. The current-origin `/login/callback` URL is only a browser fallback.
+
+## Auth
+
+Auth has two login flows.
+
+OIDC/hosted IAM login uses `auth.idp`. The SDK relies on Blocks IAM `IdpController`, sends the configured public `clientId`, and does not manually build `oidc/authorize` URLs. Refresh OIDC sessions with `auth.oidc.refreshToken()`, which calls `/iam/v4/oidc/token` and sends `client_id`.
+
+```ts
+await blocks.auth.idp.redirectToProvider();
+
+const result = await blocks.auth.idp.callback(window.location.href);
+
+const refreshed = await blocks.auth.oidc.refreshToken({
+  refreshToken: result.refresh_token,
+  clientId: "<public-browser-client-id>"
+});
+```
+
+Embedded/app-owned login UI uses AuthController methods directly on `auth`: `auth.login()`, `auth.socialInitiate(clientId, redirectUri)` (two positional strings, not an object), `auth.socialCallback(request)`, and `auth.refresh()`.
+
+```ts
+const login = await blocks.auth.login({
+  username: "user@example.com",
+  password: "password"
+});
+
+const refreshed = await blocks.auth.refresh({
+  refreshToken: login.refresh_token
+});
+```
+
+Other auth APIs, such as user info, organization switch, logout, signup, recovery, activation, auth config, user codes, client credentials, and identity providers, can be used by either flow when the app has the required token/permission.
+
+`auth.oidc.clientCredentials()` is for trusted non-browser runtimes only because it requires a client secret.
+
+`auth.accessToken()` resolves the caller-owned bearer token configured on `createBlocksClient` (string or callback). `auth.isAuthenticated()` checks the current session against IAM through `GET /iam/v4/auth/me` and returns a boolean based on the raw response status - use it instead of `userInfo()` when you need a true/false signal, since IAM's hosted IdP flow may set the session as a cookie with no local `accessToken` to inspect.
+
+```ts
+const config = await blocks.mfa.config();
+await blocks.mfa.totp.setup();
+await blocks.mfa.totp.verifySetup({ code: "123456" });
+await blocks.mfa.setMethod({ mfaType: 1 });
+const backupCodes = await blocks.mfa.backupCodes.generate();
+```
+
+## Mail And Notifications
+
+```ts
+await blocks.mail.send({
+  to: ["user@example.com"],
+  purpose: "welcome",
+  language: "en",
+  subjectDataContext: { firstName: "Ada" }
+});
+
+await blocks.mail.sendToAny({
+  to: ["qa@example.com"],
+  purpose: "welcome",
+  language: "en",
+  isTestMail: true
+});
+
+await blocks.notifier.notify({
+  userIds: ["user-id"],
+  denormalizedPayload: JSON.stringify({ orderId: "123" }),
+  saveDenormalizedPayloadAsAnObject: true
+});
+
+const inbox = await blocks.notifier.getNotifications({ isUnreadOnly: true, page: 1, pageSize: 20 });
+await blocks.notifier.markNotificationAsRead({ id: inbox.notifications[0].id });
+await blocks.notifier.markAllNotificationAsRead();
+```
+
+`mail.send`/`mail.sendToAny` call `/logic/v4/Mail/Send`/`SendToAny`. `notifier.*` calls `/logic/v4/Notifier/*`
+for sending/reading notifications; tenant notification *channel configuration* (`/os/v4/Notification/*`)
+is an admin concern handled by `@seliseblocks/cli-os`'s `notification *` commands, not this SDK.
+
+## Common Runtime Calls
+
+```ts
+const me = await blocks.iam.me();
+const orgs = await blocks.iam.organizations.my();
+const features = await blocks.iam.resources.features();
+```
+
+```ts
+const schemas = await blocks.data.schemas.list();
+const schemaInfo = await blocks.data.schemas.infoByName("Student");
+const schemaRules = await blocks.data.validations.bySchemaId("schema-id");
+
+const students = blocks.data.collection("Students");
+const rows = await students.list({ pageNo: 1, pageSize: 20 });
+await students.create({ firstName: "Test" });
+
+const graph = await blocks.data.graphql({
+  query: "{ students { items { itemId firstName } } }"
+});
+```
+
+```ts
+const upload = await blocks.data.files.presignedUploadUrl({
+  name: "avatar.png",
+  configurationName: "default",
+  parentDirectoryId: "root",
+  accessModifier: "Private"
+});
+
+await blocks.data.files.uploadToUrl({
+  url: upload.uploadUrl,
+  body: file,
+  contentType: file.type
+});
+
+const items = await blocks.data.dms.list({
+  configurationName: "default",
+  parentId: "root",
+  skip: 0,
+  take: 20
+});
+```
+
+```ts
+await blocks.localization.load("en-US", ["common", "dashboard"]);
+const label = blocks.localization.t("dashboard.title", "Dashboard");
+
+const tenantLanguages = await blocks.localization.languagesForCurrentTenant();
+const selectedKeys = await blocks.localization.keysByNames({
+  keyNames: ["dashboard.title"]
+});
+```
+
+## API Surface
+
+- `blocks.auth`: AuthController login, social login, refresh, org switch, logout, signup, recovery, activation, auth config, user codes, client credentials, identity providers.
+- `blocks.auth.idp`: hosted IdP initiate, browser redirect, callback, UI config.
+- `blocks.auth.oidc`: refresh-token and client-credentials token endpoint helpers.
+- `blocks.iam`: current user, users, roles, permissions, resources, organizations, signup settings (`blocks.iam.signupSettings`).
+- `blocks.data`: schema reads, validation reads, GraphQL gateway execution, file/storage helpers, DMS file/folder helpers, runtime collection CRUD.
+- `blocks.localization`: tenant language/module discovery, UILM dictionary loading, selected key lookup, simple `t()` lookup.
+- `blocks.mfa`: tenant MFA policy read/save, TOTP enrollment, OTP generate/resend/verify, method switch, disable, and backup codes.
+- `blocks.mail`: `send`/`sendToAny` transactional email through the tenant's configured mail provider.
+- `blocks.notifier`: `notify`, `getNotifications`, `getUnreadNotificationsBySubscriptionFilter`, `markNotificationAsRead`, `markAllNotificationAsRead`.
+
+Professional class names are exported for advanced typing and adapters: `BlocksAuthenticationClient`, `BlocksIAMClient`, `BlocksDataClient`, `BlocksLocalizationClient`, `BlocksMfaClient`, `BlocksMailClient`, and `BlocksNotifierClient`. `BlocksApiError` is exported for typed error handling - every non-2xx response from `http.request`/`http.external` throws it, exposing `status`, `statusText`, and the parsed `body`:
+
+```ts
+try {
+  await blocks.iam.me();
+} catch (error) {
+  if (error instanceof BlocksApiError) {
+    console.error(error.status, error.body);
+  }
+}
+```
+
+## Boundaries
+
+This package must not contain:
+
+- CLI client secrets
+- impersonation APIs
+- project create/list/use
+- schema/rules deploy
+- release deploy
+- token/session/PKCE storage
+- Node filesystem or OS credential storage
+- framework UI components
+- Localization authoring/admin endpoints
+- Data schema/rules mutation endpoints
+
+## Package Checks
+
+```bash
+npm test
+npm pack --dry-run
+```

package/dist/client.d.ts

@@ -3,6 +3,9 @@ import { BlocksDataClient } from "./data/data-client.js";
 import { BlocksHttpClient } from "./http/http-client.js";
 import { BlocksIAMClient } from "./iam/iam-client.js";
 import { BlocksLocalizationClient } from "./localization/localization-client.js";
+import { BlocksMailClient } from "./mail/mail-client.js";
+import { BlocksMfaClient } from "./mfa/mfa-client.js";
+import { BlocksNotifierClient } from "./notifier/notifier-client.js";
 export type BlocksOidcConfig = {
     /**
      * Public browser OIDC client id used by Blocks IAM IdpController and refresh-token calls.
@@ -55,6 +58,9 @@ export type BlocksClient = {
     http: BlocksHttpClient;
     iam: BlocksIAMClient;
     localization: BlocksLocalizationClient;
+    mail: BlocksMailClient;
+    mfa: BlocksMfaClient;
+    notifier: BlocksNotifierClient;
 };
 export type RequiredConfig = {
     accessToken?: string | (() => Promise<string | undefined> | string | undefined);

package/dist/client.js

@@ -3,6 +3,9 @@ import { BlocksDataClient } from "./data/data-client.js";
 import { BlocksHttpClient } from "./http/http-client.js";
 import { BlocksIAMClient } from "./iam/iam-client.js";
 import { BlocksLocalizationClient } from "./localization/localization-client.js";
+import { BlocksMailClient } from "./mail/mail-client.js";
+import { BlocksMfaClient } from "./mfa/mfa-client.js";
+import { BlocksNotifierClient } from "./notifier/notifier-client.js";
 /**
  * What: creates a framework-neutral Blocks SDK instance for one tenant/app runtime.
  * Why: frontend code needs a single configured entry point for IAM, Auth, Data, and Localization APIs.
@@ -18,7 +21,10 @@ export function createBlocksClient(config) {
         data: new BlocksDataClient(http),
         http,
         iam: new BlocksIAMClient(http),
-        localization: new BlocksLocalizationClient(http)
+        localization: new BlocksLocalizationClient(http),
+        mail: new BlocksMailClient(http),
+        mfa: new BlocksMfaClient(http),
+        notifier: new BlocksNotifierClient(http)
     };
 }
 function normalizeConfig(config) {

package/dist/data/data-client.d.ts

@@ -85,7 +85,7 @@ export declare class BlocksDataClient {
          */
         delete: (request: BlocksFileDeleteRequest) => Promise<unknown>;
         /**
-         * What: updates file additional properties through `POST /data/v4/Files/updateFileAdditionalInfo`.
+         * What: updates file additional properties through `POST /data/v4/Files/UpdateFileAdditionalInfo`.
          * Why: apps often need to attach searchable metadata such as agent status or business references to a file.
          * How: pass `itemId` and `additionalProperties`; the SDK forwards the request as-is except for not adding project fields.
          */

package/dist/data/data-client.js

@@ -124,11 +124,11 @@ export class BlocksDataClient {
             body: withoutProjectKey(request)
         }),
         /**
-         * What: updates file additional properties through `POST /data/v4/Files/updateFileAdditionalInfo`.
+         * What: updates file additional properties through `POST /data/v4/Files/UpdateFileAdditionalInfo`.
          * Why: apps often need to attach searchable metadata such as agent status or business references to a file.
          * How: pass `itemId` and `additionalProperties`; the SDK forwards the request as-is except for not adding project fields.
          */
-        updateAdditionalInfo: (request) => this.http.request(`${DATA_API}/Files/updateFileAdditionalInfo`, {
+        updateAdditionalInfo: (request) => this.http.request(`${DATA_API}/Files/UpdateFileAdditionalInfo`, {
             body: withoutProjectKey(request)
         }),
         /**
@@ -258,13 +258,13 @@ export class BlocksDataClient {
              */
             create: (payload) => this.graphql({
                 operationName: createField,
-                query: `mutation ${createField}($input: ${schemaName}InsertInput!) {
-  ${createField}(input: $input) {
-    acknowledged
-    itemId
-    message
-    totalImpactedData
-  }
+                query: `mutation ${createField}($input: ${schemaName}InsertInput!) {
+  ${createField}(input: $input) {
+    acknowledged
+    itemId
+    message
+    totalImpactedData
+  }
 }`,
                 variables: { input: payload }
             }),
@@ -275,13 +275,13 @@ export class BlocksDataClient {
              */
             delete: (itemId, deleteOptions = {}) => this.graphql({
                 operationName: deleteField,
-                query: `mutation ${deleteField}($filter: String, $input: ${schemaName}DeleteInput!) {
-  ${deleteField}(filter: $filter, input: $input) {
-    acknowledged
-    itemId
-    message
-    totalImpactedData
-  }
+                query: `mutation ${deleteField}($filter: String, $input: ${schemaName}DeleteInput!) {
+  ${deleteField}(filter: $filter, input: $input) {
+    acknowledged
+    itemId
+    message
+    totalImpactedData
+  }
 }`,
                 variables: {
                     filter: itemIdFilter(itemId),
@@ -323,13 +323,13 @@ export class BlocksDataClient {
              */
             update: (itemId, payload) => this.graphql({
                 operationName: updateField,
-                query: `mutation ${updateField}($filter: String, $input: ${schemaName}UpdateInput!) {
-  ${updateField}(filter: $filter, input: $input) {
-    acknowledged
-    itemId
-    message
-    totalImpactedData
-  }
+                query: `mutation ${updateField}($filter: String, $input: ${schemaName}UpdateInput!) {
+  ${updateField}(filter: $filter, input: $input) {
+    acknowledged
+    itemId
+    message
+    totalImpactedData
+  }
 }`,
                 variables: {
                     filter: itemIdFilter(itemId),
@@ -441,18 +441,18 @@ function dynamicQueryInput(options) {
     };
 }
 function collectionListQuery(fieldName, selection) {
-    return `query ${fieldName}($input: DynamicQueryInput) {
-  ${fieldName}(input: $input) {
-    items {
-${indent(selection, 6)}
-    }
-    totalCount
-    pageNo
-    pageSize
-    totalPages
-    hasNextPage
-    hasPreviousPage
-  }
+    return `query ${fieldName}($input: DynamicQueryInput) {
+  ${fieldName}(input: $input) {
+    items {
+${indent(selection, 6)}
+    }
+    totalCount
+    pageNo
+    pageSize
+    totalPages
+    hasNextPage
+    hasPreviousPage
+  }
 }`;
 }
 function selectionFor(fields) {

package/dist/index.d.ts

@@ -5,8 +5,14 @@ export type { BlocksClient, BlocksClientConfig, BlocksOidcConfig } from "./clien
 export { BlocksApiError } from "./http/errors.js";
 export { BlocksIAMClient } from "./iam/iam-client.js";
 export { BlocksLocalizationClient } from "./localization/localization-client.js";
+export { BlocksMailClient } from "./mail/mail-client.js";
+export { BlocksMfaClient } from "./mfa/mfa-client.js";
+export { BlocksNotifierClient } from "./notifier/notifier-client.js";
 export type { BlocksAuthPassThroughResponse, BlocksAuthResponse, BlocksClientCredentialsRequest, BlocksAuthLoginRequest, BlocksIdpCallbackRequest, BlocksIdpInitiateRequest, BlocksIdpInitiateResponse, BlocksLoginOption, BlocksLogoutRequest, BlocksOidcRefreshRequest, BlocksOidcUserInfo, BlocksRefreshRequest, BlocksSocialLoginRequest, BlocksSwitchOrganizationRequest } from "./auth/auth-client.js";
 export type { BlocksRequestOptions } from "./types.js";
 export type { BlocksBaseResponse, BlocksGetMyOrganizationsResponse, BlocksGetOrganizationResponse, BlocksGetOrganizationsResponse, BlocksGetPermissionResponse, BlocksGetPermissionsResponse, BlocksGetRoleResponse, BlocksGetRolesResponse, BlocksGetUserResponse, BlocksGetUsersResponse, BlocksIamListRequest, BlocksMeResponse, BlocksOrganization, BlocksPermission, BlocksQueryListResponse, BlocksQueryResponse, BlocksRole, BlocksUser } from "./iam/types.js";
 export type { BlocksDataCollection, BlocksDataListOptions, BlocksDmsCreateFolderRequest, BlocksDmsListRequest, BlocksDmsMetaDataValue, BlocksDmsUploadItem, BlocksDmsUploadRequest, BlocksFileDeleteRequest, BlocksFileGetOptions, BlocksFileInfoListRequest, BlocksFileListRequest, BlocksFileUpdateAdditionalInfoRequest, BlocksFileUploadRequest, BlocksFolderDeleteRequest, BlocksGraphqlRequest, BlocksLocalStorageUploadRequest, BlocksPagedResult, BlocksRegexGenerateRequest, BlocksSchemaFieldValidationOptions, BlocksSchemaListOptions, BlocksSchemaValidationListOptions, BlocksUploadToUrlRequest } from "./data/types.js";
-export type { BlocksLocalizationDictionary, BlocksLocalizationKey, BlocksLocalizationKeysByNamesRequest, BlocksLocalizationKeysByNamesResponse, BlocksLocalizationLanguage, BlocksLocalizationModule, BlocksLocalizationTranslationOptions } from "./localization/types.js";
+export type { BlocksLocalizationDictionary, BlocksLocalizationKey, BlocksLocalizationKeyResource, BlocksLocalizationKeysByNamesRequest, BlocksLocalizationKeysByNamesResponse, BlocksLocalizationLanguage, BlocksLocalizationModule, BlocksLocalizationTranslationOptions } from "./localization/types.js";
+export type { BlocksMfaBackupCodeUseRequest, BlocksMfaConfig, BlocksMfaConfigSaveRequest, BlocksMfaGenerateRequest, BlocksMfaPassThroughResponse, BlocksMfaResendRequest, BlocksMfaSetMethodRequest, BlocksMfaVerifyRequest, BlocksMfaVerifyTotpSetupRequest } from "./mfa/types.js";
+export type { BlocksMailPassThroughResponse, BlocksSendMailRequest, BlocksSendMailToAnyRequest } from "./mail/types.js";
+export type { BlocksGetNotificationsOptions, BlocksGetNotificationsResponse, BlocksGetUnreadNotificationsBySubscriptionFilterRequest, BlocksMarkNotificationAsReadRequest, BlocksNotifierPassThroughResponse, BlocksNotifierSubscriptionFilter, BlocksNotifyRequest, BlocksOfflineNotification } from "./notifier/types.js";

package/dist/index.js

@@ -4,3 +4,6 @@ export { BlocksDataClient } from "./data/data-client.js";
 export { BlocksApiError } from "./http/errors.js";
 export { BlocksIAMClient } from "./iam/iam-client.js";
 export { BlocksLocalizationClient } from "./localization/localization-client.js";
+export { BlocksMailClient } from "./mail/mail-client.js";
+export { BlocksMfaClient } from "./mfa/mfa-client.js";
+export { BlocksNotifierClient } from "./notifier/notifier-client.js";

package/dist/localization/types.d.ts

@@ -18,12 +18,20 @@ export type BlocksLocalizationTranslationOptions = {
     language: string;
     moduleName: string;
 };
+export type BlocksLocalizationKeyResource = {
+    characterLength?: number;
+    culture?: string;
+    value?: string;
+};
 export type BlocksLocalizationKey = Record<string, unknown> & {
+    context?: string;
+    isNewKey?: boolean;
+    isPartiallyTranslated?: boolean;
     itemId?: string;
     keyName?: string;
     moduleId?: string;
-    moduleName?: string;
-    values?: Record<string, unknown>;
+    resources?: BlocksLocalizationKeyResource[];
+    routes?: string[];
 };
 export type BlocksLocalizationKeysByNamesRequest = {
     keyNames: string[];

package/dist/mail/mail-client.d.ts

@@ -0,0 +1,23 @@
+import { BlocksHttpClient } from "../http/http-client.js";
+import { BlocksMailPassThroughResponse, BlocksSendMailRequest, BlocksSendMailToAnyRequest } from "./types.js";
+/**
+ * Mail sending surface: fires a purpose/language-templated email through the tenant's
+ * configured mail provider. Mail server/template/mailbox management (Mail/Save, Mail/Get,
+ * templates, mailbox reads) is a CLI/admin concern and is not exposed here.
+ */
+export declare class BlocksMailClient {
+    private readonly http;
+    constructor(http: BlocksHttpClient);
+    /**
+     * What: sends an email through `POST /logic/v4/Mail/Send` using the tenant's default mail configuration.
+     * Why: app code needs to trigger transactional email (welcome, password reset, alerts) without managing SMTP directly.
+     * How: pass recipients plus `purpose`/`language` to select the right template, and `subjectDataContext`/`bodyDataContext` for placeholder values.
+     */
+    send(request: BlocksSendMailRequest): Promise<BlocksMailPassThroughResponse>;
+    /**
+     * What: sends an email through `POST /logic/v4/Mail/SendToAny`.
+     * Why: some sends need a provider-routing hint the default `send` doesn't take, such as marking a test send.
+     * How: same fields as `send`, plus `isTestMail`.
+     */
+    sendToAny(request: BlocksSendMailToAnyRequest): Promise<BlocksMailPassThroughResponse>;
+}

package/dist/mail/mail-client.js

@@ -0,0 +1,28 @@
+const MAIL_API = "/logic/v4/Mail";
+/**
+ * Mail sending surface: fires a purpose/language-templated email through the tenant's
+ * configured mail provider. Mail server/template/mailbox management (Mail/Save, Mail/Get,
+ * templates, mailbox reads) is a CLI/admin concern and is not exposed here.
+ */
+export class BlocksMailClient {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * What: sends an email through `POST /logic/v4/Mail/Send` using the tenant's default mail configuration.
+     * Why: app code needs to trigger transactional email (welcome, password reset, alerts) without managing SMTP directly.
+     * How: pass recipients plus `purpose`/`language` to select the right template, and `subjectDataContext`/`bodyDataContext` for placeholder values.
+     */
+    send(request) {
+        return this.http.request(`${MAIL_API}/Send`, { body: request });
+    }
+    /**
+     * What: sends an email through `POST /logic/v4/Mail/SendToAny`.
+     * Why: some sends need a provider-routing hint the default `send` doesn't take, such as marking a test send.
+     * How: same fields as `send`, plus `isTestMail`.
+     */
+    sendToAny(request) {
+        return this.http.request(`${MAIL_API}/SendToAny`, { body: request });
+    }
+}