fix(core): Corrected typos and added missing keywords.

changelog.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 2024-10-01 - 1.1.1 - fix(core)
+Corrected typos and added missing keywords.
+
+- Added missing newline at the end of package.json.
+- Revised various typos and added missing keywords.
+
 ## 2024-09-29 - 1.1.0 - feat(web)
 Implement view container and update elements
 

npmextra.json

@@ -18,13 +18,18 @@
         "JWT",
         "TypeScript",
         "user login",
-        "user registration",
         "session handling",
         "email verification",
         "mobile verification",
         "user roles",
         "organization management",
-        "billing management"
+        "billing management",
+        "password reset",
+        "two-factor authentication",
+        "OAuth",
+        "API",
+        "user data",
+        "user sessions"
       ]
     }
   },

package.json

@@ -89,12 +89,17 @@
     "JWT",
     "TypeScript",
     "user login",
-    "user registration",
     "session handling",
     "email verification",
     "mobile verification",
     "user roles",
     "organization management",
-    "billing management"
+    "billing management",
+    "password reset",
+    "two-factor authentication",
+    "OAuth",
+    "API",
+    "user data",
+    "user sessions"
   ]
 }

readme.md

@@ -27,7 +27,7 @@ import * as domtools from '@design.estate/dees-domtools';
 import { html, render } from '@design.estate/dees-element';
 import { IdpWelcome } from './elements/idp-welcome.js';
 
-// Define asynchronous run function
+// Define an asynchronous run function
 const run = async () => {
   // Set up DOM tools
   const domtoolsInstance = await domtools.DomTools.setupDomTools();
@@ -56,10 +56,10 @@ const run = async () => {
     },
   });
 
-  // Set up service worker
+  // Set up the service worker
   const serviceWorker = await serviceworker.getServiceworkerClient();
 
-  // Render main template
+  // Render the main template
   const mainTemplate = html`
     <style>
       body {
@@ -79,7 +79,7 @@ run();
 
 ### Using the IDP Client
 
-The IDP Client is essential to communicate with the IDP server. Below is a sample on how to set up and use the IDP client:
+The IDP Client is essential to communicate with the IDP server. Below is a sample of how to set up and use the IDP client:
 
 ```typescript
 import { IdpState } from './idp.state.js';
@@ -99,7 +99,7 @@ export class IdpDemo {
         username: 'user@example.com',
         password: 'password123',
       });
-      if(response.refreshToken) {
+      if (response.refreshToken) {
         await idpClient.storeJwt(response.jwt);
         console.log("Logged in successfully, JWT stored.");
       } else {
@@ -176,7 +176,7 @@ export class IdpRegistrationStepper extends plugins.DeesElement {
         last_name: formData.LastName,
       },
     });
-    // Proceed to next steps as per the registration flow
+    // Proceed to the next steps as per the registration flow
   }
 
   private renderErrorMessage(message: string) {
@@ -219,7 +219,7 @@ export class OrganizationManager {
       organizationSlug: slug,
       action: 'manifest',
     });
-    if(response.resultingOrganization) {
+    if (response.resultingOrganization) {
       console.log(`Organization ${name} created successfully.`);
     } else {
       console.log(`Organization creation failed.`);
@@ -247,7 +247,7 @@ export const refreshJwt = async (client: IdpClient) => {
   const response = await client.requests.refreshJwt.fire({
     refreshToken: currentJwt.data.refreshToken
   });
-  if(response.jwt) {
+  if (response.jwt) {
     await client.storeJwt(response.jwt);
     console.log("JWT refreshed and stored.");
     return response.jwt;
@@ -290,7 +290,7 @@ const idpClient = new IdpClient('https://reception.lossless.one/typedrequest');
 getTransferToken(idpClient);
 ```
 
-This comprehensive guide should help you with a detailed understanding of setting up and using the `@idp.global/idp.global` module effectively.
+This comprehensive guide should help you understand the detailed setup and usage of the `@idp.global/idp.global` module effectively.
 
 ## License and Legal Information
 

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@idp.global/idp.global',
-  version: '1.1.0',
+  version: '1.1.1',
   description: 'An identity provider software managing user authentications, registrations, and sessions.'
 }

ts/ffb.plugins.ts

@@ -1,14 +0,0 @@
-// native scope
-import * as path from 'path';
-export { path };
-
-// @api.global scope
-import * as typedserver from '@api.global/typedserver';
-
-export { typedserver };
-
-// @pushrocks scope
-import * as qenv from '@push.rocks/qenv';
-import * as smartpath from '@push.rocks/smartpath';
-
-export { qenv, smartpath };

ts/index.ts

@@ -1,5 +1,6 @@
-import * as plugins from './ffb.plugins.js';
-import * as paths from './ffb.paths.js';
+import * as plugins from './plugins.js';
+import * as paths from './paths.js';
+import { Reception } from './reception/classes.reception.js';
 
 export const runCli = async () => {
   const serviceQenv = new plugins.qenv.Qenv('./', './.nogit', false);
@@ -8,5 +9,19 @@ export const runCli = async () => {
     domain: 'idp.global',
     serveDir: paths.distWebDir,
   });
+
+  // lets add the reception routes
+  const reception = new Reception({
+    name: (await serviceQenv.getEnvVarOnDemand('INSTANCE_NAME')) || 'idp.global',
+    mongoDescriptor: {
+      mongoDbUser: await serviceQenv.getEnvVarOnDemand('MONGO_DB_USER'),
+      mongoDbName: await serviceQenv.getEnvVarOnDemand('MONGO_DB_NAME'),
+      mongoDbPass: await serviceQenv.getEnvVarOnDemand('MONGO_DB_PASS'),
+      mongoDbUrl: await serviceQenv.getEnvVarOnDemand('MONGO_DB_URL'),
+    },
+    websiteServer: websiteServer,
+  });
+  await reception.start();
+
   await websiteServer.start();
 };

ts/paths.ts

@@ -1,4 +1,4 @@
-import * as plugins from './ffb.plugins.js';
+import * as plugins from './plugins.js';
 
 export const packageDir = plugins.path.join(
   plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),

ts/plugins.ts

@@ -1,34 +1,32 @@
-// node native
+// Native scope
 import * as path from 'path';
-
 export { path };
 
-// project scope
-import * as lointReception from '../../dist_ts_interfaces/index.js';
+// Project scope
+import * as lointReception from '../dist_ts_interfaces/index.js';
+export { lointReception };
 
-export { lointReception, };
-
-// @apiglobal scope
+// @api.global scope
+import * as typedserver from '@api.global/typedserver';
 import * as typedrequest from '@api.global/typedrequest';
 import * as typedsocket from '@api.global/typedsocket';
 
-export { typedrequest, typedsocket };
+export { typedserver, typedrequest, typedsocket };
 
 // @serve.zone scope
 import * as szPlatformClient from '@serve.zone/platformclient';
-
 export { szPlatformClient };
 
-
-// @pushrocks scope
+// @push.rocks scope
 import * as lik from '@push.rocks/lik';
 import * as projectinfo from '@push.rocks/projectinfo';
 import * as qenv from '@push.rocks/qenv';
 import * as smartdata from '@push.rocks/smartdata';
 import * as smartdelay from '@push.rocks/smartdelay';
+import * as smartjwt from '@push.rocks/smartjwt';
+import * as smartlog from '@push.rocks/smartlog';
 import * as smartmail from '@push.rocks/smartmail';
 import * as smarthash from '@push.rocks/smarthash';
-import * as smartjwt from '@push.rocks/smartjwt';
 import * as smartpath from '@push.rocks/smartpath';
 import * as smartpromise from '@push.rocks/smartpromise';
 import * as smarttime from '@push.rocks/smarttime';
@@ -41,9 +39,10 @@ export {
   qenv,
   smartdata,
   smartdelay,
-  smartmail,
   smarthash,
   smartjwt,
+  smartlog,
+  smartmail,
   smartpath,
   smartpromise,
   smarttime,
@@ -53,5 +52,4 @@ export {
 
 // @tsclass scope
 import * as tsclass from '@tsclass/tsclass';
-
 export { tsclass };

ts/reception/classes.apitoken.ts

@@ -1,5 +1,5 @@
 import { ApiTokenManager } from './classes.apitokenmanager.js';
-import * as plugins from './plugins.js';
+import * as plugins from '../plugins.js';
 
 @plugins.smartdata.Manager(() => {
   return (this as any).manager;

ts/reception/classes.apitokenmanager.ts

@@ -1,5 +1,5 @@
 import { Reception } from './classes.reception.js';
-import * as plugins from './plugins.js';
+import * as plugins from '../plugins.js';
 
 export class ApiTokenManager {
   public receptionRef: Reception;

ts/reception/classes.billingplan.ts

@@ -1,4 +1,4 @@
-import * as plugins from './plugins.js';
+import * as plugins from '../plugins.js';
 import { BillingPlanManager } from './classes.billingplanmanager.js';
 import { User } from './classes.user.js';
 

ts/reception/classes.billingplanmanager.ts

@@ -1,6 +1,6 @@
 import { Reception } from './classes.reception.js';
 import { BillingPlan } from './classes.billingplan.js';
-import * as plugins from './plugins.js';
+import * as plugins from '../plugins.js';
 
 export class BillingPlanManager {
   public receptionRef: Reception;

ts/reception/classes.housekeeping.ts

@@ -1,4 +1,4 @@
-import * as plugins from './plugins.js';
+import * as plugins from '../plugins.js';
 import { Reception } from './classes.reception.js';
 import { logger } from './logging.js';
 

ts/reception/classes.jwt.ts

@@ -1,4 +1,4 @@
-import * as plugins from './plugins.js';
+import * as plugins from '../plugins.js';
 import { JwtManager } from './classes.jwtmanager.js';
 
 /**

ts/reception/classes.jwtmanager.ts

@@ -1,4 +1,4 @@
-import * as plugins from './plugins.js';
+import * as plugins from '../plugins.js';
 import { Reception } from './classes.reception.js';
 import { Jwt } from './classes.jwt.js';
 
@@ -60,7 +60,7 @@ export class JwtManager {
 
   public async pushPublicKeyToClients() {
     const targetConnections =
-      await this.receptionRef.serviceServer.typedsocket.findAllTargetConnectionsByTag<plugins.lointReception.tags.ITag_LolePubapi>(
+      await this.receptionRef.options.websiteServer.typedserver.typedsocket.findAllTargetConnectionsByTag<plugins.lointReception.tags.ITag_LolePubapi>(
         'lole-reception',
         {
           backendToken: '',
@@ -68,7 +68,7 @@ export class JwtManager {
       );
     for (const targetConnection of targetConnections) {
       const pushPublicKeyTr =
-        this.receptionRef.serviceServer.typedsocket.createTypedRequest<plugins.lointReception.request.IReq_PushPublicKeyForValidation>(
+        this.receptionRef.options.websiteServer.typedserver.typedsocket.createTypedRequest<plugins.lointReception.request.IReq_PushPublicKeyForValidation>(
           'pushPublicKeyForValidation',
           targetConnection
         );
@@ -80,7 +80,7 @@ export class JwtManager {
 
   public async pushBlockedJwtIdListToClients() {
     const targetConnections =
-      await this.receptionRef.serviceServer.typedsocket.findAllTargetConnectionsByTag<plugins.lointReception.tags.ITag_LolePubapi>(
+      await this.receptionRef.options.websiteServer.typedserver.typedsocket.findAllTargetConnectionsByTag<plugins.lointReception.tags.ITag_LolePubapi>(
         'lole-reception',
         {
           backendToken: '',
@@ -88,7 +88,7 @@ export class JwtManager {
       );
       for (const targetConnection of targetConnections) {
         const pushPublicKeyTr =
-          this.receptionRef.serviceServer.typedsocket.createTypedRequest<plugins.lointReception.request.IReq_PushOrGetJwtIdBlocklist>(
+          this.receptionRef.options.websiteServer.typedserver.typedsocket.createTypedRequest<plugins.lointReception.request.IReq_PushOrGetJwtIdBlocklist>(
             'pushOrGetJwtIdBlocklist',
             targetConnection
           );

ts/reception/classes.loginsession.ts

@@ -1,4 +1,4 @@
-import * as plugins from './plugins.js';
+import * as plugins from '../plugins.js';
 import { LoginSessionManager } from './classes.loginsessionmanager.js';
 import { User } from './classes.user.js';
 

ts/reception/classes.loginsessionmanager.ts

@@ -1,4 +1,4 @@
-import * as plugins from './plugins.js';
+import * as plugins from '../plugins.js';
 import { LoginSession } from './classes.loginsession.js';
 import { Reception } from './classes.reception.js';
 

ts/reception/classes.organization.ts

@@ -1,4 +1,4 @@
-import * as plugins from './plugins.js';
+import * as plugins from '../plugins.js';
 import { OrganizationManager } from './classes.organizationmanager.js';
 import { User } from './classes.user.js';
 

ts/reception/classes.organizationmanager.ts

@@ -1,4 +1,4 @@
-import * as plugins from './plugins.js';
+import * as plugins from '../plugins.js';
 import { Reception } from './classes.reception.js';
 import { Organization } from './classes.organization.js';
 import { User } from './classes.user.js';

ts/reception/classes.reception.ts

@@ -1,11 +1,10 @@
-import * as plugins from './plugins.js';
-import * as paths from './paths.js';
+import * as plugins from '../plugins.js';
+import * as paths from '../paths.js';
 import { logger } from './logging.js';
 
 import { JwtManager } from './classes.jwtmanager.js';
 import { LoginSessionManager } from './classes.loginsessionmanager.js';
 import { RegistrationSessionManager } from './classes.registrationsessionmanager.js';
-import { ReceptionServer } from './classes.receptionserver.js';
 import { ReceptionDb } from './classes.receptiondb.js';
 import { ReceptionMailer } from './classes.receptionmailer.js';
 import { UserManager } from './classes.usermanager.js';
@@ -15,6 +14,15 @@ import { OrganizationManager } from './classes.organizationmanager.js';
 import { RoleManager } from './classes.rolemanager.js';
 import { BillingPlanManager } from './classes.billingplanmanager.js';
 
+export interface IReceptionOptions {
+  /**
+   * a name for the idp instance.
+   */
+  name: string;
+  mongoDescriptor: plugins.smartdata.IMongoDescriptor;
+  websiteServer: plugins.typedserver.utilityservers.UtilityWebsiteServer;
+}
+
 export class Reception {
   public projectinfoNpm = new plugins.projectinfo.ProjectinfoNpm(paths.packageDir);
   public typedrouter = new plugins.typedrequest.TypedRouter();
@@ -22,9 +30,6 @@ export class Reception {
   public szPlatformClient = new plugins.szPlatformClient.SzPlatformClient();
   public db = new ReceptionDb(this);
 
-  // server
-  public serviceServer = new ReceptionServer(this);
-
   // managers
   public jwtManager = new JwtManager(this);
   public loginSessionManager = new LoginSessionManager(this);
@@ -37,16 +42,25 @@ export class Reception {
   public billingPlanManager = new BillingPlanManager(this);
   housekeeping = new ReceptionHousekeeping(this);
 
-  constructor(public databaseName?: string) {}
+  constructor(public options: IReceptionOptions) {
+    if (!options.mongoDescriptor) {
+      throw new Error('mongoDescriptor is required');
+    }
+    if (!options.websiteServer) {
+      throw new Error('websiteServer is required');
+    }
+  }
 
   /**
    * starts the reception instance
    */
   public async start() {
     logger.log('info', 'starting reception');
-    await this.db.start(this.databaseName);
+    logger.log('info', 'adding typedrouter to website server');
+    this.options.websiteServer.typedrouter.addTypedRouter(this.typedrouter);
+    logger.log('info', 'starting database');
+    await this.db.start();
     await this.jwtManager.start();
-    await this.serviceServer.start();
   }
 
   /**
@@ -54,7 +68,6 @@ export class Reception {
    */
   public async stop() {
     await this.housekeeping.stop();
-    await this.serviceServer.stop();
     console.log('stopped serviceserver!');
     await this.db.stop();
   }

ts/reception/classes.receptiondb.ts

@@ -1,4 +1,4 @@
-import * as plugins from './plugins.js';
+import * as plugins from '../plugins.js';
 import { Reception } from './classes.reception.js';
 
 export class ReceptionDb {
@@ -9,13 +9,9 @@ export class ReceptionDb {
     this.receptionRef = receptionRefArg;
   }
 
-  public async start(databaseNameArg?: string) {
-    this.smartdataDb = new plugins.smartdata.SmartdataDb({
-      mongoDbUser: await this.receptionRef.serviceQenv.getEnvVarOnDemand('MONGO_DB_USER'),
-      mongoDbName: databaseNameArg || await this.receptionRef.serviceQenv.getEnvVarOnDemand('MONGO_DB_NAME'),
-      mongoDbPass: await this.receptionRef.serviceQenv.getEnvVarOnDemand('MONGO_DB_PASS'),
-      mongoDbUrl: await this.receptionRef.serviceQenv.getEnvVarOnDemand('MONGO_DB_URL'),
-    });
+  public async start() {
+    console.log(this.receptionRef.options.mongoDescriptor);
+    this.smartdataDb = new plugins.smartdata.SmartdataDb(this.receptionRef.options.mongoDescriptor);
     await this.smartdataDb.init();
   }
 

ts/reception/classes.receptionmailer.ts

@@ -1,7 +1,7 @@
 import { Reception } from './classes.reception.js';
 import { RegistrationSession } from './classes.registrationsession.js';
 import { User } from './classes.user.js';
-import * as plugins from './plugins.js';
+import * as plugins from '../plugins.js';
 
 export class ReceptionMailer {
   public receptionRef: Reception;

ts/reception/classes.receptionserver.ts

@@ -1,35 +0,0 @@
-import * as plugins from './plugins.js';
-import { Reception } from './classes.reception.js';
-
-export class ReceptionServer {
-  public receptionRef: Reception;
-  public serviceServer: plugins.loleServiceServer.ServiceServer;
-  public typedsocket: plugins.typedsocket.TypedSocket;
-
-  constructor(receptionRef: Reception) {
-    this.receptionRef = receptionRef;
-    this.serviceServer = new plugins.loleServiceServer.ServiceServer({
-      serviceDomain: 'reception.lossless.one',
-      serviceName: 'reception',
-      serviceVersion: this.receptionRef.projectinfoNpm.version,
-      port: parseInt(this.receptionRef.serviceQenv.getEnvVarOnDemand('TEST_PORT')) || 3000,
-      addCustomRoutes: async (serverArg) => {
-        serverArg.addRoute(
-          '/typedrequest',
-          new plugins.loleServiceServer.HandlerTypedRouter(this.receptionRef.typedrouter)
-        );
-      },
-    });
-  }
-
-  async start() {
-    await this.serviceServer.start();
-    this.typedsocket = this.serviceServer.typedServer.typedsocket;
-    this.serviceServer.typedServer.typedrouter.addTypedRouter(this.receptionRef.typedrouter);
-  }
-
-  async stop() {
-    await this.typedsocket.stop();
-    await this.serviceServer.stop();
-  }
-}

ts/reception/classes.receptionstorage.ts

@@ -1,4 +1,4 @@
-import * as plugins from './plugins.js';
+import * as plugins from '../plugins.js';
 
 /**
  * can be used to store binary data for users and organizations

ts/reception/classes.registrationsession.ts

@@ -1,4 +1,4 @@
-import * as plugins from './plugins.js';
+import * as plugins from '../plugins.js';
 
 import { RegistrationSessionManager } from './classes.registrationsessionmanager.js';
 import { logger } from './logging.js';
@@ -157,18 +157,13 @@ export class RegistrationSession {
    * validate the mobile number of someone
    */
   public async sendValidationSms() {
-    if (!process.env.TEST_MODE) {
-      this.smsCode =
-        await this.registrationSessionManagerRef.receptionRef.loleSmsClientInstance.sendSmsVerifcation(
-          {
-            fromName: 'w...global',
-            toNumber: parseInt(this.collectedData.userData.mobileNumber),
-          }
-        );
-    } else {
-      console.log('Not sending SMS in automated test mode');
-      this.smsCode = '123456';
-    }
+    this.smsCode =
+      await this.registrationSessionManagerRef.receptionRef.szPlatformClient.smsConnector.sendSmsVerifcation(
+        {
+          fromName: this.registrationSessionManagerRef.receptionRef.options.name,
+          toNumber: parseInt(this.collectedData.userData.mobileNumber),
+        }
+      );
   }
 
   /**

ts/reception/classes.registrationsessionmanager.ts

@@ -1,4 +1,4 @@
-import * as plugins from './plugins.js';
+import * as plugins from '../plugins.js';
 import { RegistrationSession } from './classes.registrationsession.js';
 import { Reception } from './classes.reception.js';
 import { logger } from './logging.js';

ts/reception/classes.role.ts

@@ -1,4 +1,4 @@
-import * as plugins from './plugins.js';
+import * as plugins from '../plugins.js';
 
 @plugins.smartdata.Manager()
 export class Role extends plugins.smartdata.SmartDataDbDoc<

ts/reception/classes.rolemanager.ts

@@ -2,7 +2,7 @@ import { Organization } from './classes.organization.js';
 import { Reception } from './classes.reception.js';
 import { Role } from './classes.role.js';
 import { User } from './classes.user.js';
-import * as plugins from './plugins.js';
+import * as plugins from '../plugins.js';
 
 export class RoleManager {
   // INSTANCE

ts/reception/classes.user.ts

@@ -1,4 +1,4 @@
-import * as plugins from './plugins.js';
+import * as plugins from '../plugins.js';
 import { UserManager } from './classes.usermanager.js';
 
 /**

ts/reception/classes.usermanager.ts

@@ -1,6 +1,6 @@
 import { Reception } from './classes.reception.js';
 import { User } from './classes.user.js';
-import * as plugins from './plugins.js';
+import * as plugins from '../plugins.js';
 
 /**
  * a user manager

ts/reception/index.ts

@@ -1,15 +1,2 @@
 // general exports for testing
 export * from './classes.reception.js';
-
-// running it in production
-import { Reception } from './classes.reception.js';
-
-let reception: Reception;
-export const runCli = async () => {
-  reception = new Reception();
-  await reception.start();
-};
-
-export const stop = async () => {
-  await reception.stop();
-};

ts/reception/logging.ts

@@ -1,13 +1,6 @@
-import * as plugins from './plugins.js';
-import * as paths from './paths.js';
+import * as plugins from '../plugins.js';
+import * as paths from '../paths.js';
 
 const projectinfoNpm = new plugins.projectinfo.ProjectinfoNpm(paths.packageDir);
 
-export const logger = plugins.loleLog.createLoleLogger({
-  companyUnit: 'Lossless Cloud',
-  containerName: 'reception',
-  containerVersion: projectinfoNpm.version,
-  sentryAppName: 'reception',
-  sentryDsn: 'https://fd929bdcad0a41c0b7853cdea04f9c96@o169278.ingest.sentry.io/5272722',
-  zone: 'servezone',
-});
+export const logger = new plugins.smartlog.ConsoleLog();

ts/reception/paths.ts

@@ -1,3 +0,0 @@
-import * as plugins from './plugins.js';
-
-export const packageDir = plugins.path.join(plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url), '../');

ts_web/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@idp.global/idp.global',
-  version: '1.1.0',
+  version: '1.1.1',
   description: 'An identity provider software managing user authentications, registrations, and sessions.'
 }