@particle/esim-tooling 1.0.0

package/src/types.ts

@@ -0,0 +1,264 @@
+export enum ProfileState {
+  Disabled = 0,
+  Enabled = 1,
+}
+
+export enum ProfileClass {
+  Test = 0,
+  Provisioning = 1,
+  Operational = 2,
+}
+
+export enum NotificationEvent {
+  Install = 0x80,
+  Enable = 0x40,
+  Disable = 0x20,
+  Delete = 0x10,
+}
+
+export enum DeleteNotificationStatus {
+  Ok = 0,
+  NothingToDelete = 1,
+  UndefinedError = 127,
+}
+
+export enum CancelSessionReason {
+  EndUserRejection = 0,
+  Postponed = 1,
+  Timeout = 2,
+  PprNotAllowed = 3,
+  MetadataMismatch = 4,
+  LoadBppExecutionError = 5,
+  SessionAborted = 16,
+  EnterpriseProfilesNotSupported = 17,
+  EnterpriseRulesNotAllowed = 18,
+  EnterpriseProfileNotAllowed = 19,
+  EnterpriseOidMismatch = 20,
+  EnterpriseRulesError = 21,
+  EnterpriseProfilesOnly = 22,
+  LprNotSupported = 23,
+  LprNetworkDataNotAllowed = 24,
+  EmptyProfileOrSpName = 25,
+  RpmDisabled = 27,
+  InvalidRpmPackage = 28,
+  LoadRpmPackageError = 29,
+  OperationAbandoned = 30,
+  UndefinedReason = 127,
+}
+
+export enum EnableProfileResult {
+  Ok = 0,
+  IccidOrAidNotFound = 1,
+  ProfileNotInDisabledState = 2,
+  DisallowedByPolicy = 3,
+  WrongProfileReenabling = 4,
+  CatBusy = 5,
+  DisallowedByEnterpriseRule = 6,
+  CommandError = 7,
+  DisallowedForRpm = 9,
+  NoEsimPortAvailable = 10,
+  UndefinedError = 127,
+}
+
+export enum DisableProfileResult {
+  Ok = 0,
+  IccidOrAidNotFound = 1,
+  ProfileNotInEnabledState = 2,
+  DisallowedByPolicy = 3,
+  CatBusy = 5,
+  DisallowedByEnterpriseRule = 6,
+  CommandError = 7,
+  DisallowedForRpm = 9,
+  UndefinedError = 127,
+}
+
+export enum DeleteProfileResult {
+  Ok = 0,
+  IccidOrAidNotFound = 1,
+  ProfileNotInDisabledState = 2,
+  DisallowedByPolicy = 3,
+  DisallowedInTestMode = 4,
+  CommandError = 7,
+  UndefinedError = 127,
+}
+
+/**
+ * Error codes from ProfileInstallationResult errorResult (reasonCode).
+ * Per SGP.22 Section 5.7.7.
+ */
+export enum BppInstallErrorCode {
+  IncorrectInputValues = 1,
+  InvalidSignature = 2,
+  InvalidTransactionId = 3,
+  UnsupportedCrtValues = 4,
+  UnsupportedRemoteOperationType = 5,
+  UnsupportedProfileClass = 6,
+  Scp03tStructureError = 7,
+  Scp03tSecurityError = 8,
+  IccidAlreadyExistsOnEuicc = 9,
+  InsufficientMemoryForProfile = 10,
+  InstallInterrupted = 11,
+  PeProcessingError = 12,
+  DataMismatch = 13,
+  TestProfileInvalidNaaKey = 14,
+  PprNotAllowed = 15,
+  UnknownError = 127,
+}
+
+export interface DeviceAdapter {
+  sendApdu(apdu: Uint8Array): Promise<Uint8Array>;
+}
+
+export interface ServerAdapter {
+  sendRsp(smdpAddress: string, endpoint: string, requestData: Uint8Array): Promise<ServerResponse>;
+}
+
+export interface ServerResponse {
+  statusCode: number;
+  responseData?: Uint8Array;
+}
+
+export interface Profile {
+  iccid: string;
+  isdpAid?: string;
+  state: ProfileState;
+  nickname?: string;
+  serviceProviderName?: string;
+  profileName?: string;
+  profileClass?: ProfileClass;
+}
+
+export interface NotificationMetadata {
+  seqNumber: number;
+  operation: NotificationEvent;
+  notificationAddress: string;
+  iccid?: string;
+}
+
+/**
+ * Full notification data from RetrieveNotificationsList.
+ * Includes installation result for install notifications.
+ */
+export interface Notification extends NotificationMetadata {
+  /**
+   * For install notifications: whether the installation succeeded.
+   * For other notifications (enable/disable/delete): always true (operation completed).
+   */
+  success: boolean;
+  /**
+   * Error subject code (only if success=false).
+   * See SGP.22 Section 5.7.9 for subject codes.
+   */
+  errorSubjectCode?: number;
+  /**
+   * Error reason code (only if success=false).
+   * See BppInstallErrorCode enum for common values.
+   */
+  errorReasonCode?: number;
+}
+
+/**
+ * Result of BPP loading from the eUICC.
+ * Returned after the last STORE DATA command during profile installation.
+ */
+export interface ProfileInstallationResult {
+  success: boolean;
+  /** ICCID of the installed profile (only if success=true) */
+  iccid?: string;
+  /** Error subject code (only if success=false) */
+  errorSubjectCode?: number;
+  /** Error reason code (only if success=false) */
+  errorReasonCode?: number;
+}
+
+/**
+ * Result of sending a notification to SM-DP+.
+ */
+export interface SendResult {
+  /** Whether the notification was successfully sent to SM-DP+ */
+  sent: boolean;
+  /** Whether the notification was removed from the eUICC (only attempted if sent=true) */
+  removed: boolean;
+  /** Error message if sending failed */
+  error?: string;
+}
+
+/**
+ * Notification with optional send result.
+ */
+export interface NotificationWithResult extends Notification {
+  /** Result of sending to SM-DP+. null if send option was false. */
+  sendResult: SendResult | null;
+}
+
+/**
+ * Options for processNotifications.
+ */
+export interface ProcessNotificationsOptions {
+  /** If true, only list notifications without sending to SM-DP+. Default: false (process and send) */
+  listOnly?: boolean;
+  /** If true, remove notifications from eUICC even if sending fails. Default: false */
+  forceRemove?: boolean;
+}
+
+/**
+ * Result of processNotifications.
+ */
+export interface ProcessNotificationsResult {
+  /** All notifications with their details and optional send results */
+  notifications: NotificationWithResult[];
+  /** Number of notifications successfully sent (only present when send=true) */
+  sent?: number;
+  /** Number of notifications that failed to send (only present when send=true) */
+  failed?: number;
+}
+
+export interface ActivationCode {
+  format: number;
+  smdpAddress: string;
+  matchingId: string;
+  smdpOid?: string;
+  confirmationCodeRequired: boolean;
+}
+
+export type DownloadStep =
+  | 'parseActivationCode'
+  | 'getEuiccChallenge'
+  | 'getEuiccInfo'
+  | 'initiateAuth'
+  | 'authenticateServer'
+  | 'authenticateClient'
+  | 'prepareDownload'
+  | 'getBoundProfilePackage'
+  | 'loadProfile'
+  | 'complete';
+
+export interface DownloadProgress {
+  step: DownloadStep;
+  detail?: string;
+}
+
+export interface DownloadResult {
+  success: boolean;
+  error?: string;
+  /** Error subject code from ProfileInstallationResult (only if success=false) */
+  errorSubjectCode?: number;
+  /** Error reason code from ProfileInstallationResult (only if success=false) */
+  errorReasonCode?: number;
+  iccid?: string;
+  profileMetadata?: {
+    serviceProviderName?: string;
+    profileName?: string;
+  };
+}
+
+export interface InstallProfileOptions {
+  activationCode: string;
+  confirmationCode?: string;
+  onProgress?: (progress: DownloadProgress) => void;
+}
+
+export interface EsimLpaOptions {
+  device: DeviceAdapter;
+  server: ServerAdapter;
+}