@nizam-os/carrier-sdk 2.3.3 → 2.4.0

package/dist/Client.d.ts

@@ -1,5 +1,6 @@
 import { InvitesClient } from "./api/resources/invites/client/Client.js";
 import { LookupsClient } from "./api/resources/lookups/client/Client.js";
+import { RealtimeClient } from "./api/resources/realtime/client/Client.js";
 import { UsersClient } from "./api/resources/users/client/Client.js";
 import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
 import { type NormalizedClientOptionsWithAuth } from "./BaseClient.js";
@@ -14,10 +15,12 @@ export declare class NizamCarrierClient {
     protected _invites: InvitesClient | undefined;
     protected _lookups: LookupsClient | undefined;
     protected _users: UsersClient | undefined;
+    protected _realtime: RealtimeClient | undefined;
     constructor(options: NizamCarrierClient.Options);
     get invites(): InvitesClient;
     get lookups(): LookupsClient;
     get users(): UsersClient;
+    get realtime(): RealtimeClient;
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.
      * This is useful for making requests to endpoints not yet supported in the SDK.

package/dist/Client.js

@@ -37,7 +37,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.NizamCarrierClient = void 0;
 const Client_js_1 = require("./api/resources/invites/client/Client.js");
 const Client_js_2 = require("./api/resources/lookups/client/Client.js");
-const Client_js_3 = require("./api/resources/users/client/Client.js");
+const Client_js_3 = require("./api/resources/realtime/client/Client.js");
+const Client_js_4 = require("./api/resources/users/client/Client.js");
 const BaseClient_js_1 = require("./BaseClient.js");
 const core = __importStar(require("./core/index.js"));
 class NizamCarrierClient {
@@ -51,7 +52,10 @@ class NizamCarrierClient {
         return (this._lookups ?? (this._lookups = new Client_js_2.LookupsClient(this._options)));
     }
     get users() {
-        return (this._users ?? (this._users = new Client_js_3.UsersClient(this._options)));
+        return (this._users ?? (this._users = new Client_js_4.UsersClient(this._options)));
+    }
+    get realtime() {
+        return (this._realtime ?? (this._realtime = new Client_js_3.RealtimeClient(this._options)));
     }
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.

package/dist/api/resources/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./invites/client/requests/index.js";
 export * as invites from "./invites/index.js";
 export * as lookups from "./lookups/index.js";
+export * as realtime from "./realtime/index.js";
 export * as users from "./users/index.js";

package/dist/api/resources/index.js

@@ -36,8 +36,9 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.users = exports.lookups = exports.invites = void 0;
+exports.users = exports.realtime = exports.lookups = exports.invites = void 0;
 __exportStar(require("./invites/client/requests/index.js"), exports);
 exports.invites = __importStar(require("./invites/index.js"));
 exports.lookups = __importStar(require("./lookups/index.js"));
+exports.realtime = __importStar(require("./realtime/index.js"));
 exports.users = __importStar(require("./users/index.js"));

package/dist/api/resources/realtime/client/Client.d.ts

@@ -0,0 +1,30 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as NizamCarrier from "../../../index.js";
+export declare namespace RealtimeClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Realtime (STOMP/WebSocket) session bootstrap — mint a ticket to open a connection.
+ */
+export declare class RealtimeClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<RealtimeClient.Options>;
+    constructor(options: RealtimeClient.Options);
+    /**
+     * Returns a short-lived ticket to present as `Authorization: Bearer <ticket>` on the STOMP CONNECT frame to `/ws`. Browser clients need this because their Keycloak access token lives in an HTTP-only cookie that JavaScript cannot read; native/mobile clients holding a Keycloak access token may present it directly on CONNECT and skip this call. Mint a fresh ticket per connection attempt — it expires within seconds.
+     *
+     * @param {RealtimeClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamCarrier.UnauthorizedError}
+     * @throws {@link NizamCarrier.ForbiddenError}
+     * @throws {@link NizamCarrier.InternalServerError}
+     *
+     * @example
+     *     await client.realtime.createRealtimeTicket()
+     */
+    createRealtimeTicket(requestOptions?: RealtimeClient.RequestOptions): core.HttpResponsePromise<NizamCarrier.RealtimeTicket>;
+    private __createRealtimeTicket;
+}

package/dist/api/resources/realtime/client/Client.js

@@ -0,0 +1,105 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RealtimeClient = void 0;
+const BaseClient_js_1 = require("../../../../BaseClient.js");
+const headers_js_1 = require("../../../../core/headers.js");
+const core = __importStar(require("../../../../core/index.js"));
+const environments = __importStar(require("../../../../environments.js"));
+const handleNonStatusCodeError_js_1 = require("../../../../errors/handleNonStatusCodeError.js");
+const errors = __importStar(require("../../../../errors/index.js"));
+const NizamCarrier = __importStar(require("../../../index.js"));
+/**
+ * Realtime (STOMP/WebSocket) session bootstrap — mint a ticket to open a connection.
+ */
+class RealtimeClient {
+    constructor(options) {
+        this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
+    }
+    /**
+     * Returns a short-lived ticket to present as `Authorization: Bearer <ticket>` on the STOMP CONNECT frame to `/ws`. Browser clients need this because their Keycloak access token lives in an HTTP-only cookie that JavaScript cannot read; native/mobile clients holding a Keycloak access token may present it directly on CONNECT and skip this call. Mint a fresh ticket per connection attempt — it expires within seconds.
+     *
+     * @param {RealtimeClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link NizamCarrier.UnauthorizedError}
+     * @throws {@link NizamCarrier.ForbiddenError}
+     * @throws {@link NizamCarrier.InternalServerError}
+     *
+     * @example
+     *     await client.realtime.createRealtimeTicket()
+     */
+    createRealtimeTicket(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__createRealtimeTicket(requestOptions));
+    }
+    async __createRealtimeTicket(requestOptions) {
+        const _authRequest = await this._options.authProvider.getAuthRequest();
+        const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, requestOptions?.headers);
+        const _response = await core.fetcher({
+            url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
+                (await core.Supplier.get(this._options.environment)) ??
+                environments.NizamCarrierEnvironment.Production, "v1/realtime/tickets"),
+            method: "POST",
+            headers: _headers,
+            queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body, rawResponse: _response.rawResponse };
+        }
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new NizamCarrier.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 403:
+                    throw new NizamCarrier.ForbiddenError(_response.error.body, _response.rawResponse);
+                case 500:
+                    throw new NizamCarrier.InternalServerError(_response.error.body, _response.rawResponse);
+                default:
+                    throw new errors.NizamCarrierError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v1/realtime/tickets");
+    }
+}
+exports.RealtimeClient = RealtimeClient;

package/dist/api/resources/realtime/client/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/api/resources/realtime/client/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/realtime/exports.d.ts

@@ -0,0 +1,2 @@
+export { RealtimeClient } from "./client/Client.js";
+export * from "./client/index.js";

package/dist/api/resources/realtime/exports.js

@@ -0,0 +1,21 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RealtimeClient = void 0;
+var Client_js_1 = require("./client/Client.js");
+Object.defineProperty(exports, "RealtimeClient", { enumerable: true, get: function () { return Client_js_1.RealtimeClient; } });
+__exportStar(require("./client/index.js"), exports);

package/dist/api/resources/realtime/index.d.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";

package/dist/api/resources/realtime/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client/index.js"), exports);

package/dist/api/types/ActivityResource.d.ts

@@ -0,0 +1,55 @@
+/**
+ * One entry in an organization's activity feed (append-only audit timeline).
+ */
+export interface ActivityResource {
+    /** Stable UUID of this activity row — the resource id and pagination key. */
+    id?: string | undefined;
+    /** Per-publication idempotency key — equal to the realtime ActivityFeedItem's `id` for the same event, so a client can dedupe realtime against REST. Null for directly-written audit rows. */
+    event_id?: string | undefined;
+    /** Canonical event verb. */
+    event?: ActivityResource.Event | undefined;
+    /** Human-readable narrative shown in the feed UI. */
+    description?: string | undefined;
+    /** Type of the entity the action targeted (polymorphic subject). */
+    subject_type?: string | undefined;
+    /** Id of the entity the action targeted. */
+    subject_id?: string | undefined;
+    /** Type of the actor that performed the action. */
+    causer_type?: string | undefined;
+    /** Id of the actor that performed the action. Null for system/scheduled actions. */
+    causer_id?: string | undefined;
+    /** Optional UI filtering bucket. */
+    log_name?: string | undefined;
+    /** When the activity was recorded — the authoritative timestamp. */
+    occurred_at?: string | undefined;
+    /** Object type discriminator (Stripe pattern). */
+    object?: ActivityResource.Object_ | undefined;
+}
+export declare namespace ActivityResource {
+    /** Canonical event verb. */
+    const Event: {
+        readonly Created: "created";
+        readonly Updated: "updated";
+        readonly Deleted: "deleted";
+        readonly Restored: "restored";
+        readonly StateChanged: "state_changed";
+        readonly Assigned: "assigned";
+        readonly Unassigned: "unassigned";
+        readonly Completed: "completed";
+        readonly Failed: "failed";
+        readonly Cancelled: "cancelled";
+        readonly Sent: "sent";
+        readonly Received: "received";
+        readonly Attached: "attached";
+        readonly Detached: "detached";
+        readonly LoggedIn: "logged_in";
+        readonly LoggedOut: "logged_out";
+        readonly Custom: "custom";
+    };
+    type Event = (typeof Event)[keyof typeof Event];
+    /** Object type discriminator (Stripe pattern). */
+    const Object_: {
+        readonly Activity: "activity";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/ActivityResource.js

@@ -0,0 +1,31 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActivityResource = void 0;
+var ActivityResource;
+(function (ActivityResource) {
+    /** Canonical event verb. */
+    ActivityResource.Event = {
+        Created: "created",
+        Updated: "updated",
+        Deleted: "deleted",
+        Restored: "restored",
+        StateChanged: "state_changed",
+        Assigned: "assigned",
+        Unassigned: "unassigned",
+        Completed: "completed",
+        Failed: "failed",
+        Cancelled: "cancelled",
+        Sent: "sent",
+        Received: "received",
+        Attached: "attached",
+        Detached: "detached",
+        LoggedIn: "logged_in",
+        LoggedOut: "logged_out",
+        Custom: "custom",
+    };
+    /** Object type discriminator (Stripe pattern). */
+    ActivityResource.Object_ = {
+        Activity: "activity",
+    };
+})(ActivityResource || (exports.ActivityResource = ActivityResource = {}));

package/dist/api/types/ListResponseActivityResource.d.ts

@@ -0,0 +1,27 @@
+import type * as NizamCarrier from "../index.js";
+/**
+ * Envelope for paginated list responses (Stripe-style cursor pagination).
+ */
+export interface ListResponseActivityResource {
+    /** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
+    object?: ListResponseActivityResource.Object_ | undefined;
+    /** Page of resources. Empty array when there are no matches. */
+    data?: NizamCarrier.ActivityResource[] | undefined;
+    /** True when more pages exist; pass `next_cursor` as `?starting_after=` to fetch the next page. */
+    has_more?: boolean | undefined;
+    /** True when earlier pages exist; pass `prev_cursor` as `?ending_before=` to fetch the previous page. */
+    has_previous?: boolean | undefined;
+    /** Opaque cursor for the next page. `null` on the last page. */
+    next_cursor?: string | undefined;
+    /** Opaque cursor for the previous page. `null` on the first page. */
+    prev_cursor?: string | undefined;
+    /** Page size that produced this response. */
+    limit?: number | undefined;
+}
+export declare namespace ListResponseActivityResource {
+    /** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
+    const Object_: {
+        readonly List: "list";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/ListResponseActivityResource.js

@@ -0,0 +1,11 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListResponseActivityResource = void 0;
+var ListResponseActivityResource;
+(function (ListResponseActivityResource) {
+    /** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
+    ListResponseActivityResource.Object_ = {
+        List: "list",
+    };
+})(ListResponseActivityResource || (exports.ListResponseActivityResource = ListResponseActivityResource = {}));

package/dist/api/types/RealtimeTicket.d.ts

@@ -0,0 +1,18 @@
+/**
+ * A short-lived ticket authorizing a single realtime (STOMP/WebSocket) connection.
+ */
+export interface RealtimeTicket {
+    /** The signed ticket. Send it as `Authorization: Bearer <ticket>` on the STOMP CONNECT frame to /ws. Opaque to the client; do not parse or store it. */
+    ticket?: string | undefined;
+    /** When the ticket expires (ISO-8601). Connect promptly; mint a fresh ticket for each new connection attempt. */
+    expires_at?: string | undefined;
+    /** Object type discriminator (Stripe pattern). */
+    object?: RealtimeTicket.Object_ | undefined;
+}
+export declare namespace RealtimeTicket {
+    /** Object type discriminator (Stripe pattern). */
+    const Object_: {
+        readonly RealtimeTicket: "realtime_ticket";
+    };
+    type Object_ = (typeof Object_)[keyof typeof Object_];
+}

package/dist/api/types/RealtimeTicket.js

@@ -0,0 +1,11 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RealtimeTicket = void 0;
+var RealtimeTicket;
+(function (RealtimeTicket) {
+    /** Object type discriminator (Stripe pattern). */
+    RealtimeTicket.Object_ = {
+        RealtimeTicket: "realtime_ticket",
+    };
+})(RealtimeTicket || (exports.RealtimeTicket = RealtimeTicket = {}));

package/dist/api/types/UpdateOrganizationRequest.d.ts

@@ -1,7 +1,7 @@
 export interface UpdateOrganizationRequest {
     /** New display name. Omit to leave unchanged. */
     name?: string | undefined;
-    /** New URL-safe slug. Cross-tenant unique. Cascades to the Keycloak Organization's alias. Omit to leave unchanged. */
+    /** New URL-safe slug. Cross-tenant unique. Omit to leave unchanged. */
     slug?: string | undefined;
     /** New business category — lowercase slug from /v1/lookups/business-categories. Omit to leave unchanged. */
     business_category?: string | undefined;

package/dist/api/types/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./ActiveOrganization.js";
+export * from "./ActivityResource.js";
 export * from "./ApiFieldError.js";
 export * from "./Asset.js";
 export * from "./Assignment.js";
@@ -17,6 +18,7 @@ export * from "./InternalUserUpdateRequest.js";
 export * from "./Invite.js";
 export * from "./InviteUserRequest.js";
 export * from "./Language.js";
+export * from "./ListResponseActivityResource.js";
 export * from "./ListResponseBusinessCategory.js";
 export * from "./ListResponseCountry.js";
 export * from "./ListResponseCurrency.js";
@@ -32,6 +34,7 @@ export * from "./OpenAssignmentRequest.js";
 export * from "./Operator.js";
 export * from "./Organization.js";
 export * from "./ProblemDetail.js";
+export * from "./RealtimeTicket.js";
 export * from "./ReconcileResponse.js";
 export * from "./SetActiveOrganizationRequest.js";
 export * from "./Timezone.js";

package/dist/api/types/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./ActiveOrganization.js"), exports);
+__exportStar(require("./ActivityResource.js"), exports);
 __exportStar(require("./ApiFieldError.js"), exports);
 __exportStar(require("./Asset.js"), exports);
 __exportStar(require("./Assignment.js"), exports);
@@ -33,6 +34,7 @@ __exportStar(require("./InternalUserUpdateRequest.js"), exports);
 __exportStar(require("./Invite.js"), exports);
 __exportStar(require("./InviteUserRequest.js"), exports);
 __exportStar(require("./Language.js"), exports);
+__exportStar(require("./ListResponseActivityResource.js"), exports);
 __exportStar(require("./ListResponseBusinessCategory.js"), exports);
 __exportStar(require("./ListResponseCountry.js"), exports);
 __exportStar(require("./ListResponseCurrency.js"), exports);
@@ -48,6 +50,7 @@ __exportStar(require("./OpenAssignmentRequest.js"), exports);
 __exportStar(require("./Operator.js"), exports);
 __exportStar(require("./Organization.js"), exports);
 __exportStar(require("./ProblemDetail.js"), exports);
+__exportStar(require("./RealtimeTicket.js"), exports);
 __exportStar(require("./ReconcileResponse.js"), exports);
 __exportStar(require("./SetActiveOrganizationRequest.js"), exports);
 __exportStar(require("./Timezone.js"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nizam-os/carrier-sdk",
-  "version": "2.3.3",
+  "version": "2.4.0",
   "description": "Nizam Carrier API SDK for TypeScript / JavaScript.",
   "license": "MIT",
   "private": false,