@idp.global/interfaces 1.0.1

package/ts/data/paddlecheckoutdata.ts

@@ -0,0 +1,316 @@
+export interface IPaddleCheckoutData<TPassthrough = null> {
+  checkout: {
+    created_at: string;
+    completed: boolean;
+    id: string;
+    coupon: {
+      coupon_code?: string;
+    };
+    passthrough?: TPassthrough;
+    prices: {
+      customer: {
+        currency: string;
+        unit: string;
+        unit_tax: string;
+        total: string;
+        total_tax: string;
+        items: Array<{
+          checkout_product_id: number;
+          product_id: number;
+          name: string;
+          custom_message: string;
+          quantity: number;
+          allow_quantity: false;
+          icon_url: string;
+          min_quantity: number;
+          max_quantity: number;
+          currency: string;
+          unit_price: {
+            net: number;
+            gross: number;
+            net_discount: number;
+            gross_discount: number;
+            net_after_discount: number;
+            gross_after_discount: number;
+            tax: number;
+            tax_after_discount: number;
+          };
+          line_price: {
+            net: number;
+            gross: number;
+            net_discount: number;
+            gross_discount: number;
+            net_after_discount: number;
+            gross_after_discount: number;
+            tax: number;
+            tax_after_discount: number;
+          };
+          discounts: [];
+          /**
+           * factorised, not percentage, so looks like 0.19 for Germany.
+           */
+          tax_rate: number;
+          recurring: {
+            period: string;
+            interval: number;
+            trial_days: number;
+            currency: string;
+            unit_price: {
+              net: number;
+              gross: number;
+              net_discount: number;
+              gross_discount: number;
+              net_after_discount: number;
+              gross_after_discount: number;
+              tax: number;
+              tax_after_discount: number;
+            };
+            line_price: {
+              net: number;
+              gross: number;
+              net_discount: number;
+              gross_discount: number;
+              net_after_discount: number;
+              gross_after_discount: number;
+              tax: number;
+              tax_after_discount: number;
+            };
+            discounts: [];
+            tax_rate: number;
+          };
+        }>;
+      };
+      vendor: {
+        currency: string;
+        unit: string;
+        unit_tax: string;
+        total: string;
+        total_tax: string;
+        items: [
+          {
+            checkout_product_id: number;
+            product_id: number;
+            name: string;
+            custom_message: string;
+            quantity: number;
+            allow_quantity: false;
+            icon_url: string;
+            min_quantity: number;
+            max_quantity: number;
+            currency: string;
+            unit_price: {
+              net: number;
+              gross: number;
+              net_discount: number;
+              gross_discount: number;
+              net_after_discount: number;
+              gross_after_discount: number;
+              tax: number;
+              tax_after_discount: number;
+            };
+            line_price: {
+              net: number;
+              gross: number;
+              net_discount: number;
+              gross_discount: number;
+              net_after_discount: number;
+              gross_after_discount: number;
+              tax: number;
+              tax_after_discount: number;
+            };
+            discounts: [];
+            tax_rate: number;
+            recurring: {
+              period: string;
+              interval: number;
+              trial_days: number;
+              currency: string;
+              unit_price: {
+                net: number;
+                gross: number;
+                net_discount: number;
+                gross_discount: number;
+                net_after_discount: number;
+                gross_after_discount: number;
+                tax: number;
+                tax_after_discount: number;
+              };
+              line_price: {
+                net: number;
+                gross: number;
+                net_discount: number;
+                gross_discount: number;
+                net_after_discount: number;
+                gross_after_discount: number;
+                tax: number;
+                tax_after_discount: number;
+              };
+              discounts: [];
+              tax_rate: number;
+            };
+          }
+        ];
+      };
+    };
+    redirect_url: null;
+    test_variant: 'newCheckout';
+    recurring_prices: {
+      customer: {
+        currency: string;
+        unit: string;
+        unit_tax: string;
+        total: string;
+        total_tax: string;
+        items: [
+          {
+            checkout_product_id: number;
+            product_id: number;
+            name: string;
+            custom_message: string;
+            quantity: number;
+            allow_quantity: false;
+            icon_url: string;
+            min_quantity: number;
+            max_quantity: number;
+            currency: string;
+            unit_price: {
+              net: number;
+              gross: number;
+              net_discount: number;
+              gross_discount: number;
+              net_after_discount: number;
+              gross_after_discount: number;
+              tax: number;
+              tax_after_discount: number;
+            };
+            line_price: {
+              net: number;
+              gross: number;
+              net_discount: number;
+              gross_discount: number;
+              net_after_discount: number;
+              gross_after_discount: number;
+              tax: number;
+              tax_after_discount: number;
+            };
+            discounts: [];
+            tax_rate: number;
+            recurring: {
+              period: string;
+              interval: number;
+              trial_days: number;
+              currency: string;
+              unit_price: {
+                net: number;
+                gross: number;
+                net_discount: number;
+                gross_discount: number;
+                net_after_discount: number;
+                gross_after_discount: number;
+                tax: number;
+                tax_after_discount: number;
+              };
+              line_price: {
+                net: number;
+                gross: number;
+                net_discount: number;
+                gross_discount: number;
+                net_after_discount: number;
+                gross_after_discount: number;
+                tax: number;
+                tax_after_discount: number;
+              };
+              discounts: [];
+              tax_rate: number;
+            };
+          }
+        ];
+      };
+      interval: {
+        length: number;
+        type: string;
+      };
+      vendor: {
+        currency: string;
+        unit: string;
+        unit_tax: string;
+        total: string;
+        total_tax: string;
+        items: [
+          {
+            checkout_product_id: number;
+            product_id: number;
+            name: string;
+            custom_message: string;
+            quantity: number;
+            allow_quantity: false;
+            icon_url: string;
+            min_quantity: number;
+            max_quantity: number;
+            currency: string;
+            unit_price: {
+              net: number;
+              gross: number;
+              net_discount: number;
+              gross_discount: number;
+              net_after_discount: number;
+              gross_after_discount: number;
+              tax: number;
+              tax_after_discount: number;
+            };
+            line_price: {
+              net: number;
+              gross: number;
+              net_discount: number;
+              gross_discount: number;
+              net_after_discount: number;
+              gross_after_discount: number;
+              tax: number;
+              tax_after_discount: number;
+            };
+            discounts: [];
+            tax_rate: number;
+            recurring: {
+              period: string;
+              interval: number;
+              trial_days: number;
+              currency: string;
+              unit_price: {
+                net: number;
+                gross: number;
+                net_discount: number;
+                gross_discount: number;
+                net_after_discount: number;
+                gross_after_discount: number;
+                tax: number;
+                tax_after_discount: number;
+              };
+              line_price: {
+                net: number;
+                gross: number;
+                net_discount: number;
+                gross_discount: number;
+                net_after_discount: number;
+                gross_after_discount: number;
+                tax: number;
+                tax_after_discount: number;
+              };
+              discounts: [];
+              tax_rate: number;
+            };
+          }
+        ];
+      };
+    };
+  };
+  product: {
+    quantity: number;
+    id: number;
+    name: string;
+  };
+  user: {
+    id: string;
+    email: string;
+    country: string;
+  };
+}

package/ts/data/passportchallenge.ts

@@ -0,0 +1,80 @@
+import type { IPassportCapabilities } from './passportdevice.js';
+
+export type TPassportChallengeType =
+  | 'device_enrollment'
+  | 'authentication'
+  | 'step_up'
+  | 'physical_access';
+
+export type TPassportChallengeStatus = 'pending' | 'approved' | 'expired' | 'rejected';
+
+export type TPassportChallengeDeliveryStatus = 'pending' | 'sent' | 'failed' | 'seen';
+
+export type TPassportSignatureFormat = 'raw' | 'der';
+
+export interface IPassportLocationEvidence {
+  latitude: number;
+  longitude: number;
+  accuracyMeters: number;
+  capturedAt: number;
+}
+
+export interface IPassportNfcEvidence {
+  tagId?: string;
+  readerId?: string;
+}
+
+export interface IPassportLocationPolicy {
+  mode: 'geofence';
+  label?: string;
+  latitude: number;
+  longitude: number;
+  radiusMeters: number;
+  maxAccuracyMeters?: number;
+}
+
+export interface IPassportChallenge {
+  id: string;
+  data: {
+    userId: string;
+    deviceId?: string | null;
+    type: TPassportChallengeType;
+    status: TPassportChallengeStatus;
+    tokenHash?: string | null;
+    challenge: string;
+    metadata: {
+      originHost?: string;
+      audience?: string;
+      notificationTitle?: string;
+      deviceLabel?: string;
+      requireLocation: boolean;
+      requireNfc: boolean;
+      locationPolicy?: IPassportLocationPolicy;
+      requestedCapabilities?: Partial<IPassportCapabilities>;
+    };
+    evidence?: {
+      signatureFormat?: TPassportSignatureFormat;
+      location?: IPassportLocationEvidence;
+      locationEvaluation?: {
+        matched: boolean;
+        distanceMeters?: number;
+        accuracyAccepted?: boolean;
+        evaluatedAt: number;
+        reason?: string;
+      };
+      nfc?: IPassportNfcEvidence;
+    };
+    notification?: {
+      hintId: string;
+      status: TPassportChallengeDeliveryStatus;
+      attemptCount: number;
+      createdAt: number;
+      deliveredAt?: number | null;
+      seenAt?: number | null;
+      lastError?: string | null;
+    };
+    createdAt: number;
+    expiresAt: number;
+    completedAt?: number | null;
+  };
+}

package/ts/data/passportdevice.ts

@@ -0,0 +1,46 @@
+export type TPassportDevicePlatform =
+  | 'ios'
+  | 'ipados'
+  | 'macos'
+  | 'watchos'
+  | 'android'
+  | 'web'
+  | 'unknown';
+
+export type TPassportDeviceStatus = 'active' | 'revoked';
+
+export type TPassportPushProvider = 'apns';
+
+export type TPassportPushEnvironment = 'development' | 'production';
+
+export interface IPassportCapabilities {
+  gps: boolean;
+  nfc: boolean;
+  push: boolean;
+}
+
+export interface IPassportDevice {
+  id: string;
+  data: {
+    userId: string;
+    label: string;
+    platform: TPassportDevicePlatform;
+    status: TPassportDeviceStatus;
+    publicKeyAlgorithm: 'p256';
+    publicKeyX963Base64: string;
+    capabilities: IPassportCapabilities;
+    pushRegistration?: {
+      provider: TPassportPushProvider;
+      token: string;
+      topic: string;
+      environment: TPassportPushEnvironment;
+      registeredAt: number;
+      lastDeliveredAt?: number;
+      lastError?: string;
+    };
+    appVersion?: string;
+    createdAt: number;
+    lastSeenAt?: number;
+    lastChallengeAt?: number;
+  };
+}

package/ts/data/passportnonce.ts

@@ -0,0 +1,9 @@
+export interface IPassportNonce {
+  id: string;
+  data: {
+    deviceId: string;
+    nonceHash: string;
+    createdAt: number;
+    expiresAt: number;
+  };
+}

package/ts/data/property.ts

@@ -0,0 +1,12 @@
+import * as plugins from '../plugins.js';
+import { type IRole } from './role.js';
+
+export interface ISubOrgProperty {
+  name: string;
+  domain: string;
+  roles: IRole[];
+  /**
+   * contains the ids of all the apps that show the property
+   */
+  attributedAppIds: string[];
+}

package/ts/data/registrationsession.ts

@@ -0,0 +1,31 @@
+export type TRegistrationSessionStatus =
+  | 'announced'
+  | 'emailValidated'
+  | 'mobileVerified'
+  | 'registered'
+  | 'failed';
+
+export interface IRegistrationSession {
+  id: string;
+  data: {
+    emailAddress: string;
+    hashedEmailToken: string;
+    smsCodeHash?: string | null;
+    smsvalidationCounter: number;
+    status: TRegistrationSessionStatus;
+    validUntil: number;
+    createdAt: number;
+    collectedData: {
+      userData: {
+        username?: string | null;
+        connectedOrgs: string[];
+        email?: string | null;
+        name?: string | null;
+        status?: 'new' | 'active' | 'deleted' | 'suspended' | null;
+        mobileNumber?: string | null;
+        password?: string | null;
+        passwordHash?: string | null;
+      };
+    };
+  };
+}

package/ts/data/role.ts

@@ -0,0 +1,33 @@
+import * as plugins from '../plugins.js';
+
+/** Standard role types available in all organizations */
+export type TStandardRole = 'owner' | 'admin' | 'editor' | 'guest' | 'viewer' | 'outlaw';
+
+export interface IOrgRoleDefinition {
+  key: string;
+  name: string;
+  description?: string;
+  createdAt: number;
+  updatedAt: number;
+}
+
+export interface IAppRoleMapping {
+  orgRoleKey: string;
+  appRoles: string[];
+  permissions: string[];
+  scopes: string[];
+}
+
+/**
+ * A role describes a user's permissions within an organization.
+ * Users can have multiple roles (e.g., ['owner', 'billing-admin']).
+ */
+export interface IRole {
+  id: string;
+  data: {
+    userId: string;
+    organizationId: string;
+    /** Array of roles - supports standard roles and custom role names */
+    roles: string[];
+  };
+}

package/ts/data/user.ts

@@ -0,0 +1,36 @@
+import * as plugins from '../plugins.js';
+import { type IRole } from './role.js';
+
+export interface IUser {
+  id: string;
+  data: {
+    name: string;
+    username: string;
+    email: string;
+
+    /**
+     * mobile number used for verification
+     */
+    mobileNumber?: string;
+    /**
+     * only used during initial password setting
+     */
+    password?: string;
+    /**
+     * used for validation of passwords
+     */
+    passwordHash?: string;
+    status: 'new' | 'active' | 'deleted' | 'suspended';
+    /**
+     * a quick ref for which organizations might have roles for this user
+     * speeds up lookup
+     */
+    connectedOrgs: string[];
+    /**
+     * Platform-level admin flag
+     * Users with this flag can access the global admin panel
+     * to manage global apps, view platform stats, etc.
+     */
+    isGlobalAdmin?: boolean;
+  };
+}

package/ts/data/userinvitation.ts

@@ -0,0 +1,58 @@
+import * as plugins from '../plugins.js';
+
+/**
+ * A UserInvitation represents an invitation to join an organization.
+ * Key characteristics:
+ * - Unique by email (multiple orgs can share the same invitation)
+ * - Converts to real User on registration or folds into existing user
+ * - Auto-expires after 90 days
+ */
+export interface IUserInvitation {
+  id: string;
+  data: {
+    /** The invited email address - unique key for sharing across orgs */
+    email: string;
+
+    /** Secure token for invitation link validation */
+    token: string;
+
+    /** Current status of the invitation */
+    status: 'pending' | 'accepted' | 'expired' | 'cancelled';
+
+    /** When the invitation was first created */
+    createdAt: number;
+
+    /** When the invitation expires (createdAt + 90 days) */
+    expiresAt: number;
+
+    /**
+     * Organizations that have invited this email.
+     * Multiple orgs can link to the same invitation.
+     */
+    organizationRefs: IOrganizationInvitationRef[];
+
+    /** When the invitation was accepted (user registered/folded) */
+    acceptedAt?: number;
+
+    /** The User ID after conversion (when accepted) */
+    convertedToUserId?: string;
+  };
+}
+
+/**
+ * Represents one organization's invitation to the user.
+ * Stored as part of IUserInvitation.organizationRefs array.
+ */
+export interface IOrganizationInvitationRef {
+  /** The organization that sent this invitation */
+  organizationId: string;
+
+  /** The user who sent the invitation */
+  invitedByUserId: string;
+
+  /** When this org invited the user */
+  invitedAt: number;
+
+  /** Roles to assign when the invitation is accepted */
+  roles: string[];
+}

package/ts/index.ts

@@ -0,0 +1,6 @@
+// requests
+import * as request from './request/index.js';
+import * as data from './data/index.js';
+import * as tags from './tags/index.js';
+
+export { request, data, tags };

package/ts/plugins.ts

@@ -0,0 +1,9 @@
+// @apiglobal scope
+import * as typedRequestInterfaces from '@api.global/typedrequest-interfaces';
+
+export { typedRequestInterfaces };
+
+// @tsclass scope
+import * as tsclass from '@tsclass/tsclass';
+
+export { tsclass };