@nizam-os/operator-sdk 4.0.0 → 5.1.0

package/dist/api/types/OperatorAsset.js

@@ -0,0 +1,33 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OperatorAsset = void 0;
+var OperatorAsset;
+(function (OperatorAsset) {
+    /** Top-level kind. */
+    OperatorAsset.Kind = {
+        GroundVehicle: "ground_vehicle",
+        AerialVehicle: "aerial_vehicle",
+        MarineVehicle: "marine_vehicle",
+        Robot: "robot",
+        Agv: "agv",
+        Trailer: "trailer",
+        Container: "container",
+        Pallet: "pallet",
+        Equipment: "equipment",
+    };
+    /** Lifecycle status. */
+    OperatorAsset.Status = {
+        Active: "active",
+        Maintenance: "maintenance",
+        OutOfService: "out_of_service",
+        Retired: "retired",
+        Sold: "sold",
+        Inactive: "inactive",
+        Lost: "lost",
+    };
+    /** Object type discriminator. */
+    OperatorAsset.Object_ = {
+        Asset: "asset",
+    };
+})(OperatorAsset || (exports.OperatorAsset = OperatorAsset = {}));

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

@@ -3,11 +3,11 @@
  */
 export interface OperatorPosition {
     /** Operator id. */
-    operator_id?: string | undefined;
+    operator_id: string;
     /** Latitude (WGS84). */
-    lat?: number | undefined;
+    lat: number;
     /** Longitude (WGS84). */
-    lng?: number | undefined;
+    lng: number;
     /** Direction of travel, compass degrees [0,360). */
     heading?: number | undefined;
     /** Course over ground, compass degrees [0,360). */
@@ -17,8 +17,8 @@ export interface OperatorPosition {
     /** Altitude above the WGS84 ellipsoid, metres. */
     altitude?: number | undefined;
     /** Device-time of the fix. */
-    captured_at?: string | undefined;
-    object?: OperatorPosition.Object_ | undefined;
+    captured_at: string;
+    object: OperatorPosition.Object_;
 }
 export declare namespace OperatorPosition {
     const Object_: {

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

@@ -3,23 +3,23 @@
  */
 export interface Organization {
     /** Stable UUID owned by Nizam. Pin this value in URLs and external integrations. The matching Keycloak Organization is tracked server-side via a separate keycloak_id bridge and is not exposed over the SDK; do not assume the two ids are equal. */
-    id?: string | undefined;
+    id: string;
     /** Display name. */
-    name?: string | undefined;
+    name: string;
     /** URL-safe identifier — used in deep links and admin tooling. */
-    slug?: string | undefined;
+    slug: string;
     /** Lifecycle status. */
-    status?: Organization.Status | undefined;
+    status: Organization.Status;
     /** User id of the human who originally created this organization. Immutable for the row's lifetime — does NOT change when ownership is transferred. */
-    founder_user_id?: string | undefined;
+    founder_user_id: string;
     /** User id of the current owner. Receives all admin notifications by default. Mutable; reassigned via ownership transfer. May be null transiently if the owner user has been hard-deleted. */
     owner_user_id?: string | undefined;
     /** When this organization was created. */
-    created_at?: string | undefined;
+    created_at: string;
     /** Populated ONLY on the POST /v1/organizations create response — the active organization id Nizam pinned for the founder as part of the same transaction that created the org. Null on every other endpoint (GET, list, membership embeds). Per issue #67 phase 1, the SPA writes its active-org cookie from this field instead of issuing a follow-up PATCH /v1/me/active-organization. */
     active_organization_id?: string | undefined;
     /** Object type discriminator. */
-    object?: Organization.Object_ | undefined;
+    object: Organization.Object_;
 }
 export declare namespace Organization {
     /** Lifecycle status. */

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

@@ -3,13 +3,13 @@
  */
 export interface Position {
     /** Position id. */
-    id?: string | undefined;
+    id: string;
     /** Operator the fix belongs to. */
-    operator_id?: string | undefined;
+    operator_id: string;
     /** Latitude (WGS84). */
-    lat?: number | undefined;
+    lat: number;
     /** Longitude (WGS84). */
-    lng?: number | undefined;
+    lng: number;
     /** Direction of travel, compass degrees [0,360). */
     heading?: number | undefined;
     /** Course over ground toward the destination, compass degrees [0,360). */
@@ -19,8 +19,8 @@ export interface Position {
     /** Altitude above the WGS84 ellipsoid, metres. */
     altitude?: number | undefined;
     /** Device-time the fix was captured (authoritative). */
-    recorded_at?: string | undefined;
-    object?: Position.Object_ | undefined;
+    recorded_at: string;
+    object: Position.Object_;
 }
 export declare namespace Position {
     const Object_: {

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

@@ -16,6 +16,6 @@ export interface ProblemDetail {
     code: string;
     /** OpenTelemetry trace id from the request — match to logs for support. */
     trace_id?: string | undefined;
-    /** Per-field validation errors. Populated only when status=422. */
+    /** Per-field errors keyed to the offending input. Present on 422 bean-validation failures AND on field-level 409 conflicts (e.g. a duplicate unique value such as a VIN) — bind each entry to its `field`; do not gate handling on `status == 422`. */
     errors?: NizamOperatorRuntime.ApiFieldError[] | undefined;
 }

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

@@ -3,11 +3,11 @@
  */
 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;
+    ticket: string;
     /** When the ticket expires (ISO-8601). Connect promptly; mint a fresh ticket for each new connection attempt. */
-    expires_at?: string | undefined;
+    expires_at: string;
     /** Object type discriminator. */
-    object?: RealtimeTicket.Object_ | undefined;
+    object: RealtimeTicket.Object_;
 }
 export declare namespace RealtimeTicket {
     /** Object type discriminator. */

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

@@ -4,13 +4,13 @@ import type * as NizamOperatorRuntime from "../index.js";
  */
 export interface ReconcileResponse {
     /** Nizam org ids whose stored keycloak_id no longer resolves on the KC side. */
-    nizam_has_kc_missing?: string[] | undefined;
+    nizam_has_kc_missing: string[];
     /** KC org ids with no matching Nizam organizations.keycloak_id row. */
-    kc_has_nizam_missing?: string[] | undefined;
+    kc_has_nizam_missing: string[];
     /** Per-org membership-set divergences (KC vs Nizam). */
-    membership_divergent?: NizamOperatorRuntime.MembershipDriftResponse[] | undefined;
+    membership_divergent: NizamOperatorRuntime.MembershipDriftResponse[];
     /** Object type discriminator. */
-    object?: ReconcileResponse.Object_ | undefined;
+    object: ReconcileResponse.Object_;
 }
 export declare namespace ReconcileResponse {
     /** Object type discriminator. */

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

@@ -4,11 +4,11 @@ import type * as NizamOperatorRuntime from "../index.js";
  */
 export interface TaskAttemptPhoto {
     /** Photo record id. */
-    id?: string | undefined;
+    id: string;
     /** Central file id — request bytes via the files download-url endpoint. */
-    file_id?: string | undefined;
+    file_id: string;
     /** Display order within the attempt. */
-    sequence?: number | undefined;
+    sequence: number;
     /** Photo category, when categorised. */
     photo_type?: string | undefined;
     /** Operator-entered caption. */
@@ -16,11 +16,11 @@ export interface TaskAttemptPhoto {
     /** Device capture time (EXIF), when reported. */
     taken_at?: string | undefined;
     /** May the bytes be served right now (scan verdict + lifecycle)? */
-    downloadable?: boolean | undefined;
-    thumbnails?: NizamOperatorRuntime.TaskAttemptPhotoThumbnail[] | undefined;
+    downloadable: boolean;
+    thumbnails: NizamOperatorRuntime.TaskAttemptPhotoThumbnail[];
     /** When the photo row was recorded. */
-    created_at?: string | undefined;
-    object?: TaskAttemptPhoto.Object_ | undefined;
+    created_at: string;
+    object: TaskAttemptPhoto.Object_;
 }
 export declare namespace TaskAttemptPhoto {
     const Object_: {

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

@@ -3,13 +3,13 @@
  */
 export interface Timezone {
     /** IANA timezone id (e.g. `America/New_York`). */
-    id?: string | undefined;
+    id: string;
     /** Long display name in the Accept-Language locale. */
-    display_name?: string | undefined;
+    display_name: string;
     /** Current offset from UTC in minutes (DST-aware). */
-    gmt_offset_minutes?: number | undefined;
+    gmt_offset_minutes: number;
     /** Object type discriminator. */
-    object?: Timezone.Object_ | undefined;
+    object: Timezone.Object_;
 }
 export declare namespace Timezone {
     /** Object type discriminator. */

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

@@ -0,0 +1,21 @@
+/**
+ * Update mutable fields on an asset (set-only partial update).
+ */
+export interface UpdateAssetRequest {
+    /** New display name. Omit to leave unchanged. */
+    name?: string | undefined;
+    /** New sub-kind. Omit to leave unchanged. */
+    sub_kind?: string | undefined;
+    /** New SAE J3016 autonomy level 0..5. Omit to leave unchanged. */
+    autonomy_level?: number | undefined;
+    /** New VIN — 17 chars of A-Z (no I, O, Q) and 0-9, uppercase. Unique per organization. Omit to leave unchanged. */
+    vin?: string | undefined;
+    /** New license plate. Omit to leave unchanged. */
+    plate_number?: string | undefined;
+    /** New manufacturer. Omit to leave unchanged. */
+    make?: string | undefined;
+    /** New model designation. Omit to leave unchanged. */
+    model?: string | undefined;
+    /** New model year — 1900 or later, no later than next year. Omit to leave unchanged. */
+    year?: number | undefined;
+}

package/dist/api/types/UpdateAssetRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -4,15 +4,15 @@ import type * as NizamOperatorRuntime from "../index.js";
  */
 export interface UploadInitiation {
     /** Upload session id — the handle for resume/complete/cancel. */
-    upload_session_id?: string | undefined;
+    upload_session_id: string;
     /** Pre-reserved file id — the id the completed file WILL carry. */
-    file_id?: string | undefined;
+    file_id: string;
     /** Fixed size of every part except the last. */
-    part_size_bytes?: number | undefined;
+    part_size_bytes: number;
     /** Session deadline; the sweep aborts the upload after this. */
-    expires_at?: string | undefined;
-    parts?: NizamOperatorRuntime.UploadInitiationPart[] | undefined;
-    object?: UploadInitiation.Object_ | undefined;
+    expires_at: string;
+    parts: NizamOperatorRuntime.UploadInitiationPart[];
+    object: UploadInitiation.Object_;
 }
 export declare namespace UploadInitiation {
     const Object_: {

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

@@ -3,12 +3,14 @@
  */
 export interface User {
     /** Stable UUID. Equal to the Keycloak `sub` claim. */
-    id?: string | undefined;
+    id: string;
     /** Which portal issued the bearer token used for this request. */
-    portal?: User.Portal | undefined;
+    portal: User.Portal;
     /** Keycloak Organization id the user belongs to. Null for cross-tenant platform admins. */
     organization_id?: string | undefined;
-    roles?: string[] | undefined;
+    roles: string[];
+    /** The caller's effective permission ids for the active organization (epic #317): the union of catalog grants for every role they hold. Gate actions on these (`can("asset:create")`) rather than role strings, so frontend and backend reference the one catalog and cannot drift. Coarse and instance-independent; per-instance authority ('may delete THIS asset') is enforced server-side at the mutation, never precomputed here. */
+    permissions: User.Permissions.Item[];
     /** Email shadowed from Keycloak. Null until the user completes a profile. */
     email?: string | undefined;
     /** Display name shadowed from Keycloak. */
@@ -16,11 +18,11 @@ export interface User {
     /** Timestamp of this login. Null only on the very first call before provisioning completes. */
     last_login_at?: string | undefined;
     /** Total logins observed by this service. */
-    login_count?: number | undefined;
+    login_count: number;
     /** File id of the current profile picture (epic #151 / #166); null until one is uploaded. Request bytes via the files download-url endpoint, or let `GET /users/{id}/profile-picture` pick the nearest thumbnail. */
     profile_picture_file_id?: string | undefined;
     /** Object type discriminator. */
-    object?: User.Object_ | undefined;
+    object: User.Object_;
 }
 export declare namespace User {
     /** Which portal issued the bearer token used for this request. */
@@ -34,6 +36,26 @@ export declare namespace User {
         readonly Admin: "admin";
     };
     type Portal = (typeof Portal)[keyof typeof Portal];
+    type Permissions = Permissions.Item[];
+    namespace Permissions {
+        const Item: {
+            readonly AssetCreate: "asset:create";
+            readonly AssetDelete: "asset:delete";
+            readonly AssetDispose: "asset:dispose";
+            readonly AssetExport: "asset:export";
+            readonly AssetImport: "asset:import";
+            readonly AssetRead: "asset:read";
+            readonly AssetTransition: "asset:transition";
+            readonly AssetUpdate: "asset:update";
+            readonly KeycloakProjectionAdminister: "keycloak-projection:administer";
+            readonly NotificationDeliveryRead: "notification-delivery:read";
+            readonly OrgMaintenanceAdminister: "org-maintenance:administer";
+            readonly ServiceAccountAdminister: "service-account:administer";
+            readonly UserAdminister: "user:administer";
+            readonly UserInvite: "user:invite";
+        };
+        type Item = (typeof Item)[keyof typeof Item];
+    }
     /** Object type discriminator. */
     const Object_: {
         readonly User: "user";

package/dist/api/types/User.js

@@ -14,6 +14,25 @@ var User;
         PlatformStaff: "platform_staff",
         Admin: "admin",
     };
+    let Permissions;
+    (function (Permissions) {
+        Permissions.Item = {
+            AssetCreate: "asset:create",
+            AssetDelete: "asset:delete",
+            AssetDispose: "asset:dispose",
+            AssetExport: "asset:export",
+            AssetImport: "asset:import",
+            AssetRead: "asset:read",
+            AssetTransition: "asset:transition",
+            AssetUpdate: "asset:update",
+            KeycloakProjectionAdminister: "keycloak-projection:administer",
+            NotificationDeliveryRead: "notification-delivery:read",
+            OrgMaintenanceAdminister: "org-maintenance:administer",
+            ServiceAccountAdminister: "service-account:administer",
+            UserAdminister: "user:administer",
+            UserInvite: "user:invite",
+        };
+    })(Permissions = User.Permissions || (User.Permissions = {}));
     /** Object type discriminator. */
     User.Object_ = {
         User: "user",

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

@@ -3,9 +3,9 @@
  */
 export interface UserResource {
     /** Stable UUID. */
-    id?: string | undefined;
+    id: string;
     /** Lifecycle status. */
-    status?: UserResource.Status | undefined;
+    status: UserResource.Status;
     /** Email shadowed from Keycloak. */
     email?: string | undefined;
     /** Display name. */
@@ -13,9 +13,9 @@ export interface UserResource {
     /** Timestamp of the last login. */
     last_login_at?: string | undefined;
     /** Total logins observed. */
-    login_count?: number | undefined;
+    login_count: number;
     /** Object type discriminator. */
-    object?: UserResource.Object_ | undefined;
+    object: UserResource.Object_;
 }
 export declare namespace UserResource {
     /** Lifecycle status. */

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

@@ -1,5 +1,7 @@
 export * from "./ActiveOrganization.js";
 export * from "./ActivityResource.js";
+export * from "./AllowedTransitions.js";
+export * from "./AllowedTransitionsRequest.js";
 export * from "./ApiFieldError.js";
 export * from "./Asset.js";
 export * from "./AssetListItem.js";
@@ -19,6 +21,7 @@ export * from "./CreateTeleoperatedOperatorRequest.js";
 export * from "./Currency.js";
 export * from "./Device.js";
 export * from "./Devices.js";
+export * from "./ExportAssetsRequest.js";
 export * from "./File_.js";
 export * from "./FileDownloadUrl.js";
 export * from "./FileUploadPart.js";
@@ -66,6 +69,7 @@ export * from "./NotificationsMarkedRead.js";
 export * from "./NotificationUnreadCount.js";
 export * from "./OpenAssignmentRequest.js";
 export * from "./Operator.js";
+export * from "./OperatorAsset.js";
 export * from "./OperatorPosition.js";
 export * from "./Organization.js";
 export * from "./Position.js";
@@ -77,6 +81,7 @@ export * from "./SetActiveOrganizationRequest.js";
 export * from "./TaskAttemptPhoto.js";
 export * from "./TaskAttemptPhotoThumbnail.js";
 export * from "./Timezone.js";
+export * from "./UpdateAssetRequest.js";
 export * from "./UpdateOrganizationRequest.js";
 export * from "./UploadInitiation.js";
 export * from "./UploadInitiationPart.js";

package/dist/api/types/index.js

@@ -16,6 +16,8 @@ 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("./AllowedTransitions.js"), exports);
+__exportStar(require("./AllowedTransitionsRequest.js"), exports);
 __exportStar(require("./ApiFieldError.js"), exports);
 __exportStar(require("./Asset.js"), exports);
 __exportStar(require("./AssetListItem.js"), exports);
@@ -35,6 +37,7 @@ __exportStar(require("./CreateTeleoperatedOperatorRequest.js"), exports);
 __exportStar(require("./Currency.js"), exports);
 __exportStar(require("./Device.js"), exports);
 __exportStar(require("./Devices.js"), exports);
+__exportStar(require("./ExportAssetsRequest.js"), exports);
 __exportStar(require("./File_.js"), exports);
 __exportStar(require("./FileDownloadUrl.js"), exports);
 __exportStar(require("./FileUploadPart.js"), exports);
@@ -82,6 +85,7 @@ __exportStar(require("./NotificationsMarkedRead.js"), exports);
 __exportStar(require("./NotificationUnreadCount.js"), exports);
 __exportStar(require("./OpenAssignmentRequest.js"), exports);
 __exportStar(require("./Operator.js"), exports);
+__exportStar(require("./OperatorAsset.js"), exports);
 __exportStar(require("./OperatorPosition.js"), exports);
 __exportStar(require("./Organization.js"), exports);
 __exportStar(require("./Position.js"), exports);
@@ -93,6 +97,7 @@ __exportStar(require("./SetActiveOrganizationRequest.js"), exports);
 __exportStar(require("./TaskAttemptPhoto.js"), exports);
 __exportStar(require("./TaskAttemptPhotoThumbnail.js"), exports);
 __exportStar(require("./Timezone.js"), exports);
+__exportStar(require("./UpdateAssetRequest.js"), exports);
 __exportStar(require("./UpdateOrganizationRequest.js"), exports);
 __exportStar(require("./UploadInitiation.js"), exports);
 __exportStar(require("./UploadInitiationPart.js"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nizam-os/operator-sdk",
-  "version": "4.0.0",
+  "version": "5.1.0",
   "description": "Nizam Operator API SDK for TypeScript / JavaScript.",
   "license": "MIT",
   "private": false,