initial

ts_interfaces/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @push.rocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@losslessone_private/loint-reception',
+  version: '1.0.122',
+  description: 'an interface package for the reception service at Lossless'
+}

ts_interfaces/data/index.ts

@@ -0,0 +1,9 @@
+export * from './loint-reception.app.js';
+export * from './loint-reception.billingplan.js';
+export * from './loint-reception.device.js';
+export * from './loint-reception.jwt.js';
+export * from './loint-reception.loginsession.js';
+export * from './loint-reception.organization.js';
+export * from './loint-reception.paddlecheckoutdata.js';
+export * from './loint-reception.role.js';
+export * from './loint-reception.user.js';

ts_interfaces/data/loint-reception.app.ts

@@ -0,0 +1,13 @@
+export interface IApp {
+  /**
+   * must be unique
+   */
+  id: string;
+  /**
+   * should be unique
+   */
+  name: string;
+  description: string;
+  logoUrl: string;
+  appUrl: string;
+}

ts_interfaces/data/loint-reception.billingplan.ts

@@ -0,0 +1,47 @@
+import * as plugins from '../loint-reception.plugins.js';
+
+export type TSupportedCurrency = 'EUR';
+
+export interface IBillableItem {
+  name: string;
+  monthlyPrice: number;
+  currency: TSupportedCurrency;
+  from: number;
+  to: number;
+  factoredOn30DayMonth: number;
+  quantity: number;
+}
+
+export interface IBillingPlan {
+  id: string;
+  data: {
+    type: 'Paddle' | 'AppSumo' | 'FairUsageFree' | 'Enterprise' | 'Internal' | 'Testing';
+    proEnabled: boolean;
+    organizationId: string;
+    lastProcessed: number;
+    seats: number;
+    status: 'active' | 'activeOverdue' | 'pausedOverdue' | 'inactive' | 'suspended';
+    paddleData?: {
+      checkoutId: string;
+    };
+    alternativePaymentData?: {
+      enterprise: boolean;
+      appSumoCode: string;
+    };
+    nextBilling: {
+      items: Array<IBillableItem>;
+      method: 'paddle';
+      ontrack: boolean;
+      errorText?: string;
+      selectedBillingDate: number;
+    };
+    billingEvents: Array<{
+      timestamp: number;
+      amount: number;
+      currency: TSupportedCurrency;
+      billedItems: Array<IBillableItem>;
+      checkoutLink?: string;
+    }>;
+    communications: Array<any>;
+  };
+}

ts_interfaces/data/loint-reception.device.ts

@@ -0,0 +1,3 @@
+import * as plugins from '../loint-reception.plugins.js';
+
+export interface IDevice extends plugins.tsclass.network.IDevice {}

ts_interfaces/data/loint-reception.jwt.ts

@@ -0,0 +1,38 @@
+export type TLoginStatus = 'loggedIn' | 'loggedOut' | 'invalidated' | 'not found' | 'transfer';
+export type TLoginAction = 'login' | 'logout' | 'manage';
+
+export interface IJwt {
+  id: string;
+  blocked: boolean;
+  data: {
+    /**
+     * the user id of the jwt
+     */
+    userId: string;
+
+    /**
+     * the latest point of
+     */
+    validUntil: number;
+    /**
+     * hold off from refreshing before
+     */
+    refreshFrom: number;
+    /**
+     * an interval in millis to recheck token invalidation
+     */
+    refreshEvery: number;
+
+    /**
+     * the refresh token to obtain a new jwt for a session
+     */
+    refreshToken: string;
+
+    /**
+     * just for looks/debugging
+     */
+    justForLooks: {
+      validUntilIsoString: string;
+    };
+  };
+}

ts_interfaces/data/loint-reception.loginsession.ts

@@ -0,0 +1,14 @@
+export interface ILoginSession {
+  id: string;
+  data: {
+    userId: string;
+    validUntil: number;
+    invalidated: boolean;
+    refreshToken: string;
+    /**
+     * a device id that can be used to share the login session
+     * in different contexts on the same device
+     */
+    deviceId: string;
+  };
+}

ts_interfaces/data/loint-reception.organization.ts

@@ -0,0 +1,13 @@
+import * as plugins from '../loint-reception.plugins.js';
+import { type IBillingPlan } from './loint-reception.billingplan.js';
+import { type IRole } from './loint-reception.role.js';
+
+export interface IOrganization {
+  id: string;
+  data: {
+    name: string;
+    slug: string;
+    billingPlanId: string;
+    roleIds: string[];
+  };
+}

ts_interfaces/data/loint-reception.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;
+  };
+}

ts_interfaces/data/loint-reception.property.ts

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

ts_interfaces/data/loint-reception.role.ts

@@ -0,0 +1,13 @@
+import * as plugins from '../loint-reception.plugins.js';
+
+/**
+ * a role describes a
+ */
+export interface IRole {
+  id: string;
+  data: {
+    userId: string;
+    organizationId: string;
+    role: 'owner' | 'admin' | 'editor' | 'guest' | 'viewer' | 'outlaw';
+  };
+}

ts_interfaces/data/loint-reception.user.ts

@@ -0,0 +1,30 @@
+import * as plugins from '../loint-reception.plugins.js';
+import { type IRole } from './loint-reception.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[];
+  };
+}

ts_interfaces/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 };

ts_interfaces/loint-reception.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 };

ts_interfaces/request/index.ts

@@ -0,0 +1,9 @@
+export * from './loint-reception.apitoken.js';
+export * from './loint-reception.authorization.js';
+export * from './loint-reception.billingplan.js';
+export * from './loint-reception.jwt.js';
+export * from './loint-reception.login.js';
+export * from './loint-reception.organization.js';
+export * from './loint-reception.plan.js';
+export * from './loint-reception.registration.js';
+export * from './loint-reception.user.js';

ts_interfaces/request/loint-reception.apitoken.ts

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

ts_interfaces/request/loint-reception.authorization.ts

@@ -0,0 +1,19 @@
+import * as plugins from '../loint-reception.plugins.js';
+import { type IUser, type IRole } from '../data/index.js';
+
+export interface IReq_InternalAuthorization
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_InternalAuthorization
+  > {
+  method: '';
+  request: {
+    accountData: IUser;
+    jwt: string;
+  };
+  response: {
+    accountData: IUser;
+    jwt: string;
+    relevantRoles: IRole[];
+  };
+}

ts_interfaces/request/loint-reception.billingplan.ts

@@ -0,0 +1,39 @@
+import * as plugins from '../loint-reception.plugins.js';
+import * as data from '../data/index.js';
+
+export interface IReq_UpdatePaymentMethod
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_UpdatePaymentMethod
+  > {
+  method: 'updatePaymentMethod';
+  request: {
+    jwtString: string;
+    orgId: string;
+    paddle?: {
+      checkoutId: string;
+    };
+  };
+  response: {
+    billingPlan: plugins.tsclass.typeFest.PartialDeep<data.IBillingPlan>;
+  };
+}
+
+/**
+ * allows getting the billing plan for a user
+ */
+export interface IReq_GetBillingPlan
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_GetBillingPlan
+  > {
+  method: 'getBillingPlan';
+  request: {
+    jwtString: string;
+    orgId: string;
+    billingPlanId: string;
+  };
+  response: {
+    billingPlan: data.IBillingPlan;
+  };
+}

ts_interfaces/request/loint-reception.jwt.ts

@@ -0,0 +1,45 @@
+import * as data from '../data/index.js';
+import * as plugins from '../loint-reception.plugins.js';
+
+export interface IReq_GetPublicKeyForValidation
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_GetPublicKeyForValidation
+  > {
+  method: 'getPublicKeyForValidation';
+  request: {
+    backendToken: string;
+  };
+  response: {
+    publicKeyPem: string;
+  };
+}
+
+export interface IReq_PushPublicKeyForValidation
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_PushPublicKeyForValidation
+  > {
+  method: 'pushPublicKeyForValidation';
+  request: {
+    publicKeyPem: string;
+  };
+  response: {};
+}
+
+/**
+ * allows getting or pushing a blocklist of jwt ids
+ */
+export interface IReq_PushOrGetJwtIdBlocklist
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_PushOrGetJwtIdBlocklist
+  > {
+  method: 'pushOrGetJwtIdBlocklist';
+  request: {
+    blockedJwtIds?: string[];
+  };
+  response: {
+    blockedJwtIds?: string[];
+  };
+}

ts_interfaces/request/loint-reception.login.ts

@@ -0,0 +1,180 @@
+import * as plugins from '../loint-reception.plugins.js';
+import * as data from '../data/index.js';
+
+export interface IReq_LoginWithEmailOrUsernameAndPassword
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_LoginWithEmailOrUsernameAndPassword
+  > {
+  method: 'loginWithEmailOrUsernameAndPassword';
+  request: {
+    username: string;
+    password: string;
+  };
+  response: {
+    refreshToken?: string;
+    twoFaNeeded: boolean;
+  };
+}
+
+export interface IReq_LoginWithEmail
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_LoginWithEmailOrUsernameAndPassword
+  > {
+  method: 'loginWithEmail';
+  request: {
+    email: string;
+  };
+  response: {
+    status: 'ok' | 'not ok';
+    testOnlyToken?: string;
+  };
+}
+
+export interface IReq_LoginWithEmailAfterEmailTokenAquired
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_LoginWithEmailOrUsernameAndPassword
+  > {
+  method: 'loginWithEmailAfterEmailTokenAquired';
+  request: {
+    email: string;
+    token: string;
+  };
+  response: {
+    refreshToken: string;
+  };
+}
+
+/**
+ * in case you authenticate with a long lived api token
+ */
+export interface IReq_LoginWithApiToken
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_LoginWithApiToken
+  > {
+  method: 'loginWithApiToken';
+  request: {
+    apiToken: string;
+  };
+  response: {
+    jwt?: string;
+  };
+}
+
+export interface ILogoutRequest
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    ILogoutRequest
+  > {
+  method: 'logout';
+  request: {
+    refreshToken: string;
+  };
+  response: {};
+}
+
+export interface IReq_RefreshJwt
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_RefreshJwt
+  > {
+  method: 'refreshJwt';
+  request: {
+    refreshToken: string;
+  };
+  response: {
+    status: data.TLoginStatus;
+    jwt: string;
+  };
+}
+
+/**
+ * allows the exchange between refreshToken and transferTokens
+ */
+export interface IReq_ExchangeRefreshTokenAndTransferToken
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_ExchangeRefreshTokenAndTransferToken
+  > {
+  method: 'exchangeRefreshTokenAndTransferToken';
+  request: {
+    transferToken?: string;
+    refreshToken?: string;
+    appData: data.IApp;
+  };
+  response: {
+    refreshToken?: string;
+    transferToken?: string;
+  };
+}
+
+/**
+ * in case you authenticate with a long lived api token
+ */
+export interface IReq_ResetPassword
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_ResetPassword
+  > {
+  method: 'resetPassword';
+  request: {
+    email: string;
+  };
+  response: {
+    status: 'ok' | 'not ok';
+  };
+}
+
+/**
+ * in cse you authenticate with a long lived api token
+ */
+export interface IReq_SetNewPassword
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_SetNewPassword
+  > {
+  method: 'setNewPassword';
+  request: {
+    email: string;
+    oldPassword?: string;
+    tokenArg?: string;
+    newPassword: string;
+  };
+  response: {
+    status: 'ok' | 'not ok';
+  };
+}
+
+export interface IReq_ObtainDeviceId
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_ObtainDeviceId
+  > {
+  method: 'obtainDeviceId';
+  request: {};
+  response: {
+    deviceId: data.IDevice;
+  };
+}
+
+/**
+ * allows attaching a device id to a login session
+ * to share a login session across contexts
+ */
+export interface IReq_AttachDeviceId
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_AttachDeviceId
+  > {
+  method: 'attachDeviceId';
+  request: {
+    jwt: string;
+    deviceId: string;
+  };
+  response: {
+    ok: boolean;
+  };
+}

ts_interfaces/request/loint-reception.organization.ts

@@ -0,0 +1,51 @@
+import * as data from '../data/index.js';
+import * as plugins from '../loint-reception.plugins.js';
+
+export interface IReq_GetOrganizationById
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_GetOrganizationById
+  > {
+  method: 'getOrganizationById';
+  request: {
+    jwt: string;
+    id: string;
+  };
+  response: {
+    organization: data.IOrganization;
+  };
+}
+
+export interface IReq_CreateOrganization
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_CreateOrganization
+  > {
+  method: 'createOrganization';
+  request: {
+    jwt: string;
+    userId: string;
+    organizationName: string;
+    organizationSlug: string;
+    action: 'checkAvailability' | 'manifest';
+  };
+  response: {
+    nameAvailable: boolean;
+    resultingOrganization?: data.IOrganization;
+    role?: data.IRole;
+  };
+}
+
+export interface IReq_UpdateOrganization
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_UpdateOrganization
+  > {
+  method: 'updateOrganization';
+  request: {
+    organization: data.IOrganization;
+  };
+  response: {
+    organization: data.IOrganization;
+  };
+}

ts_interfaces/request/loint-reception.plan.ts

@@ -0,0 +1,17 @@
+import * as data from '../data/index.js';
+import * as plugins from '../loint-reception.plugins.js';
+
+export interface IReq_GetPlansForOrganizationId
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_GetPlansForOrganizationId
+  > {
+  method: 'getBillingPlansForOrganizationId';
+  request: {
+    jwt: string;
+    organizationId: string;
+  };
+  response: {
+    billingPlans: data.IBillingPlan[];
+  };
+}

ts_interfaces/request/loint-reception.registration.ts

@@ -0,0 +1,90 @@
+import * as plugins from '../loint-reception.plugins.js';
+import { type IUser } from '../data/index.js';
+
+export interface IReq_FirstRegistration
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_FirstRegistration
+  > {
+  method: 'firstRegistrationRequest';
+  request: {
+    email: string;
+    productSlugOfInterest: string;
+  };
+  response: {
+    status: 'ok' | 'not ok';
+    testOnlyToken?: string;
+  };
+}
+
+export interface IReq_AfterRegistrationEmailClicked
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_AfterRegistrationEmailClicked
+  > {
+  method: 'afterRegistrationEmailClicked';
+  request: {
+    /**
+     * the token that has been sent with the registation email to verify access
+     */
+    token: string;
+  };
+  response: {
+    status: 'ok' | 'not ok';
+    /**
+     * the email thats associated with the given request token
+     */
+    email: string;
+  };
+}
+
+export interface IReq_SetDataForRegistration
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_SetDataForRegistration
+  > {
+  method: 'setDataForRegistration';
+  request: {
+    token: string;
+    userData: IUser['data'];
+  };
+  response: {
+    status: 'ok' | 'not ok';
+  };
+}
+
+/**
+ * Should be used to verify a mobile number for an verifcation
+ */
+export interface IReq_MobileVerificationForRegistration
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_MobileVerificationForRegistration
+  > {
+  method: 'mobileVerificationForRegistration';
+  request: {
+    token: string;
+    mobileNumber?: string;
+    verificationCode?: string;
+  };
+  response: {
+    messageSent?: boolean;
+    verficationCodeOk?: boolean;
+    testOnlySmsCode?: string;
+  };
+}
+
+export interface IReq_FinishRegistration
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_FinishRegistration
+  > {
+  method: 'finishRegistration';
+  request: {
+    token: string;
+  };
+  response: {
+    status: 'ok' | 'not ok';
+    userData?: IUser['data'];
+  };
+}

ts_interfaces/request/loint-reception.user.ts

@@ -0,0 +1,76 @@
+import * as data from '../data/index.js';
+import * as plugins from '../loint-reception.plugins.js';
+
+export interface IReq_GetUserData
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_GetUserData
+  > {
+  method: 'getUserData';
+  request: {
+    refreshToken: string;
+  };
+  response: {
+    jwt: string;
+  };
+}
+
+export interface IReq_SetUserData
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_SetUserData
+  > {
+  method: 'setUserData';
+  request: {
+    refreshToken: string;
+  };
+  response: {
+    oneTimeTransferCode: string;
+  };
+}
+
+export interface IReq_SuspendUser
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_SuspendUser
+  > {
+  method: 'suspendUser';
+  request: {
+    jwt: string;
+    userId: string;
+  };
+  response: {
+    publicKeyPem: string;
+  };
+}
+
+export interface IDeleteSuspendedUser
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IDeleteSuspendedUser
+  > {
+  method: 'deleteSuspendedUser';
+  request: {
+    backendToken: string;
+  };
+  response: {
+    ok: boolean;
+    errorText?: string;
+  };
+}
+
+export interface IReq_GetRolesAndOrganizationsForUserId
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    IReq_GetRolesAndOrganizationsForUserId
+  > {
+  method: 'getRolesAndOrganizationsForUserId';
+  request: {
+    jwt: string;
+    userId: string;
+  };
+  response: {
+    roles: data.IRole[];
+    organizations: data.IOrganization[];
+  };
+}

ts_interfaces/tags/index.ts

@@ -0,0 +1,12 @@
+import * as plugins from '../loint-reception.plugins.js';
+
+export interface ITag_LolePubapi
+  extends plugins.typedRequestInterfaces.implementsTag<
+    plugins.typedRequestInterfaces.ITag,
+    ITag_LolePubapi
+  > {
+  name: 'lole-reception';
+  payload: {
+    backendToken: string;
+  };
+}