@vsaas/loopback 12.1.1 → 12.2.1

package/dist/lib/two-factor/service.d.cts

@@ -0,0 +1,78 @@
+import { NormalizedTwoFactorConfig } from "./config.cjs";
+import { AuthenticationRateLimiter } from "./rate-limit.cjs";
+//#region src/lib/two-factor/service.d.ts
+declare class TwoFactorService {
+  private readonly User;
+  private readonly config;
+  private readonly rateLimiter;
+  private readonly app;
+  private readonly Credential;
+  private readonly Challenge;
+  private readonly RecoveryCode;
+  private readonly dummyPasswordUser;
+  constructor(User: any, config: NormalizedTwoFactorConfig | null, rateLimiter: AuthenticationRateLimiter | null, app: any);
+  login(credentials: any, include: any, options: any, callback?: (error?: any, token?: any) => void): Promise<any>;
+  verifyTwoFactor(verification: any, options?: any, callback?: (error?: any, token?: any) => void): Promise<any>;
+  beginEnrollment(userId: any, request: any, options: any, callback?: Function): Promise<{
+    enrollmentId: string;
+    secret: string;
+    keyUri: string;
+    expiresIn: number;
+  }>;
+  confirmEnrollment(userId: any, request: any, options: any, callback?: Function): Promise<{
+    enabled: boolean;
+    recoveryCodes: string[];
+  }>;
+  regenerateRecoveryCodes(userId: any, request: any, options: any, callback?: Function): Promise<{
+    recoveryCodes: any;
+  }>;
+  disable(userId: any, request: any, options: any, callback?: Function): Promise<{
+    enabled: boolean;
+  }>;
+  deletePrincipals(principalIds: ReadonlyArray<any>, callback?: Function): Promise<void>;
+  rotateEncryption(options?: any, callback?: Function): Promise<{
+    credentialsReencrypted: number;
+    challengesReencrypted: number;
+    conflicts: number;
+    remainingCredentials: number;
+    remainingChallenges: number;
+  }>;
+  private requireConfig;
+  private loginInternal;
+  private validateLoginQuery;
+  private canonicalIdentifier;
+  private consumePasswordFailures;
+  private resolveSource;
+  private hasPassword;
+  private issueAccessToken;
+  private buildTwoFactorTokenOptions;
+  private secretAad;
+  private challengeAad;
+  private principalBinding;
+  private assertPrincipalBinding;
+  private createChallenge;
+  private createInlineRecoveryOperation;
+  private verifyChallengeInternal;
+  private verifyCredentialFactor;
+  private reserveRecoveryCode;
+  private confirmRecoveryReservation;
+  private releaseRecoveryReservation;
+  private compensateChallengeFailure;
+  private beginEnrollmentInternal;
+  private confirmEnrollmentInternal;
+  private regenerateRecoveryCodesInternal;
+  private disableInternal;
+  private authenticatedUser;
+  private reauthenticateManagement;
+  private consumeManagementFailure;
+  private enabledCredential;
+  private persistRecoverySet;
+  private deletePrincipalsInternal;
+  private rotateEncryptionInternal;
+  private revokeSessions;
+  private revokeToken;
+  private reportCleanupError;
+  private audit;
+}
+//#endregion
+export { TwoFactorService };

package/dist/lib/two-factor/totp.cjs

@@ -0,0 +1,50 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_runtime = require("../../_virtual/_rolldown/runtime.cjs");
+//#region src/lib/two-factor/totp.ts
+function generateTotpSecret(bytes) {
+	return otplib.generateSecret({ length: bytes });
+}
+function generateTotpUri(secret, issuer, accountName, parameters) {
+	return otplib.generateURI({
+		issuer,
+		label: accountName,
+		secret,
+		algorithm: parameters.algorithm.toLowerCase(),
+		digits: parameters.digits,
+		period: parameters.period
+	});
+}
+function verifyTotp(secret, token, parameters, maxClockSkewSteps, nowMs = Date.now()) {
+	if (typeof token !== "string" || !new RegExp(`^\\d{${parameters.digits}}$`).test(token)) return {
+		valid: false,
+		counter: -1
+	};
+	const result = otplib.verifySync({
+		secret,
+		token,
+		algorithm: parameters.algorithm.toLowerCase(),
+		digits: parameters.digits,
+		period: parameters.period,
+		epoch: Math.floor(nowMs / 1e3),
+		epochTolerance: maxClockSkewSteps * parameters.period
+	});
+	return {
+		valid: result.valid === true,
+		counter: result.valid ? result.timeStep : -1
+	};
+}
+var otplib;
+var init_totp = require_runtime.__esmMin((() => {
+	otplib = require("otplib");
+}));
+//#endregion
+init_totp();
+exports.generateTotpSecret = generateTotpSecret;
+exports.generateTotpUri = generateTotpUri;
+Object.defineProperty(exports, "init_totp", {
+	enumerable: true,
+	get: function() {
+		return init_totp;
+	}
+});
+exports.verifyTotp = verifyTotp;

package/dist/lib/two-factor/totp.d.cts

@@ -0,0 +1,14 @@
+//#region src/lib/two-factor/totp.d.ts
+interface TotpParameters {
+  algorithm: 'SHA1' | 'SHA256';
+  digits: 6 | 8;
+  period: number;
+}
+declare function generateTotpSecret(bytes: number): string;
+declare function generateTotpUri(secret: string, issuer: string, accountName: string, parameters: TotpParameters): string;
+declare function verifyTotp(secret: string, token: string, parameters: TotpParameters, maxClockSkewSteps: number, nowMs?: number): {
+  valid: boolean;
+  counter: number;
+};
+//#endregion
+export { TotpParameters, generateTotpSecret, generateTotpUri, verifyTotp };

package/dist/lib/utils.d.cts

@@ -0,0 +1,36 @@
+//#region src/lib/utils.d.ts
+declare function createPromiseCallback(): any;
+declare function asCallback(promise: any, cb: any): any;
+declare function invokeWithCallback(fn: any, receiver: any, args: any): Promise<unknown>;
+/**
+ * Divide an async call with large array into multiple calls using smaller chunks
+ * @param {Array} largeArray - the large array to be chunked
+ * @param {Number} chunkSize - size of each chunks
+ * @param {Function} processFunction - the function to be called multiple times
+ * @param {Function} cb - the callback
+ */
+declare function uploadInChunks(largeArray: any, chunkSize: any, processFunction: any, cb: any): any;
+/**
+ * Page async download calls
+ * @param {Object} filter - filter object used for the async call
+ * @param {Number} chunkSize - size of each chunks
+ * @param {Function} processFunction - the function to be called multiple times
+ * @param {Function} cb - the callback
+ */
+declare function downloadInChunks(filter: any, chunkSize: any, processFunction: any, cb: any): any;
+/**
+ * Concat current results into previous results
+ * Assumption made here that the previous results and current results are homogeneous
+ * @param {Object|Array} previousResults
+ * @param {Object|Array} currentResults
+ */
+declare function concatResults(previousResults: any, currentResults: any): any;
+declare const utils: {
+  asCallback: typeof asCallback;
+  concatResults: typeof concatResults;
+  createPromiseCallback: typeof createPromiseCallback;
+  downloadInChunks: typeof downloadInChunks;
+  invokeWithCallback: typeof invokeWithCallback;
+  uploadInChunks: typeof uploadInChunks;
+};
+export = utils;

package/dist/package.cjs

@@ -2,7 +2,7 @@
 var require_package = /* @__PURE__ */ require("./_virtual/_rolldown/runtime.cjs").__commonJSMin(((exports, module) => {
 	module.exports = {
 		"name": "@vsaas/loopback",
-		"version": "12.1.1",
+		"version": "12.2.1",
 		"description": "Fork of LoopBack 3 framework for building APIs and microservices in Node.js",
 		"keywords": [
 			"StrongLoop",
@@ -38,21 +38,56 @@ var require_package = /* @__PURE__ */ require("./_virtual/_rolldown/runtime.cjs"
 		"files": [
 			"dist",
 			"common/models",
+			"docs",
 			"templates",
 			"favicon.ico",
 			"README.md",
 			"LICENSE"
 		],
 		"main": "dist/index.cjs",
+		"types": "dist/index.d.cts",
 		"exports": {
-			".": "./dist/index.cjs",
+			".": {
+				"types": "./dist/index.d.cts",
+				"require": "./dist/index.cjs",
+				"default": "./dist/index.cjs"
+			},
+			"./rate-limit": {
+				"types": "./dist/lib/rate-limit/types.d.cts",
+				"require": "./dist/lib/rate-limit/types.cjs",
+				"default": "./dist/lib/rate-limit/types.cjs"
+			},
 			"./common/models/*.json": "./common/models/*.json",
-			"./common/models/*.js": "./dist/common/models/*.cjs",
-			"./common/models/*": "./dist/common/models/*.cjs",
-			"./lib/*.js": "./dist/lib/*.cjs",
-			"./lib/*": "./dist/lib/*.cjs",
-			"./server/middleware/*.js": "./dist/server/middleware/*.cjs",
-			"./server/middleware/*": "./dist/server/middleware/*.cjs",
+			"./common/models/*.js": {
+				"types": "./dist/common/models/*.d.cts",
+				"require": "./dist/common/models/*.cjs",
+				"default": "./dist/common/models/*.cjs"
+			},
+			"./common/models/*": {
+				"types": "./dist/common/models/*.d.cts",
+				"require": "./dist/common/models/*.cjs",
+				"default": "./dist/common/models/*.cjs"
+			},
+			"./lib/*.js": {
+				"types": "./dist/lib/*.d.cts",
+				"require": "./dist/lib/*.cjs",
+				"default": "./dist/lib/*.cjs"
+			},
+			"./lib/*": {
+				"types": "./dist/lib/*.d.cts",
+				"require": "./dist/lib/*.cjs",
+				"default": "./dist/lib/*.cjs"
+			},
+			"./server/middleware/*.js": {
+				"types": "./dist/server/middleware/*.d.cts",
+				"require": "./dist/server/middleware/*.cjs",
+				"default": "./dist/server/middleware/*.cjs"
+			},
+			"./server/middleware/*": {
+				"types": "./dist/server/middleware/*.d.cts",
+				"require": "./dist/server/middleware/*.cjs",
+				"default": "./dist/server/middleware/*.cjs"
+			},
 			"./package.json": "./package.json"
 		},
 		"publishConfig": {
@@ -71,7 +106,7 @@ var require_package = /* @__PURE__ */ require("./_virtual/_rolldown/runtime.cjs"
 			"typecheck": "tsc --noEmit"
 		},
 		"dependencies": {
-			"@aws-sdk/client-sesv2": "3.1034.0",
+			"@aws-sdk/client-sesv2": "^3.1115.0",
 			"@vsaas/loopback-connector-remote": "workspace:^",
 			"@vsaas/loopback-datasource-juggler": "workspace:^",
 			"@vsaas/remoting": "workspace:^",
@@ -82,7 +117,8 @@ var require_package = /* @__PURE__ */ require("./_virtual/_rolldown/runtime.cjs"
 			"express": "catalog:",
 			"isemail": "^3.2.0",
 			"loopback-filters": "^1.1.1",
-			"nodemailer": "^9.0.1",
+			"nodemailer": "^9.0.5",
+			"otplib": "catalog:",
 			"serve-favicon": "^2.5.1"
 		},
 		"devDependencies": {

package/dist/server/middleware/context.d.cts

@@ -0,0 +1,3 @@
+//#region src/server/middleware/context.d.ts
+declare function context(): void;
+export = context;

package/dist/server/middleware/error-handler.d.cts

@@ -0,0 +1,3 @@
+//#region src/server/middleware/error-handler.d.ts
+declare function errorHandler(options: any): void;
+export = errorHandler;

package/dist/server/middleware/favicon.d.cts

@@ -0,0 +1,7 @@
+//#region src/server/middleware/favicon.d.ts
+/**
+ * Serve the LoopBack favicon.
+ * @header loopback.favicon()
+ */
+declare function serveFavicon(icon: any, options: any): any;
+export = serveFavicon;

package/dist/server/middleware/rest.d.cts

@@ -0,0 +1,6 @@
+//#region src/server/middleware/rest.d.ts
+/*!
+ * Export the middleware.
+ */
+declare function rest(): (req: any, res: any, next: any) => any;
+export = rest;

package/dist/server/middleware/static.d.cts

@@ -0,0 +1,3 @@
+//#region src/server/middleware/static.d.ts
+declare const _default: any;
+export = _default;

package/dist/server/middleware/status.d.cts

@@ -0,0 +1,19 @@
+//#region src/server/middleware/status.d.ts
+/*!
+ * Export the middleware.
+ */
+/**
+ * Return [HTTP response](http://expressjs.com/4x/api.html#res.send) with basic application status information:
+ * date the application was started and uptime, in JSON format.
+ * For example:
+ * ```js
+ * {
+ *  "started": "2014-06-05T00:26:49.750Z",
+ *  "uptime": 9.394
+ * }
+ * ```
+ *
+ * @header loopback.status()
+ */
+declare function status(): (req: any, res: any) => void;
+export = status;

package/dist/server/middleware/token.d.cts

@@ -0,0 +1,3 @@
+//#region src/server/middleware/token.d.ts
+declare function token(options: any): (req: any, res: any, next: any) => any;
+export = token;

package/dist/server/middleware/url-not-found.d.cts

@@ -0,0 +1,13 @@
+//#region src/server/middleware/url-not-found.d.ts
+/*!
+ * Export the middleware.
+ * See discussion in Connect pull request #954 for more details
+ * https://github.com/senchalabs/connect/pull/954.
+ */
+/**
+ * Convert any request not handled so far to a 404 error
+ * to be handled by error-handling middleware.
+ * @header loopback.urlNotFound()
+ */
+declare function urlNotFound(): (req: any, res: any, next: any) => void;
+export = urlNotFound;

package/docs/api-explorer-details.md

@@ -0,0 +1,110 @@
+<!-- NOTE: This file is not currently included into the docs.  Need to (a) decide if this info is important and if so (b) decide where to put it.
+
+-->
+
+# REST API specs
+
+LoopBack API Explorer is built on top of the popular
+[Swagger Framework](https://github.com/wordnik/swagger-core/wiki). There are two
+components involved.
+
+1. LoopBack builds up formal specifications of the REST APIs using the knowledge of
+   model definitions, JavaScript method declarations, and remote mappings. The
+   specifications are served over the following endpoints.
+
+2. The wonderful Web UI is brought you by [Swagger UI](https://github.com/strongloop/swagger-ui).
+   Swagger UI is a collection of HTML, Javascript, and CSS assets that dynamically
+   generate beautiful documentation and sandbox from the REST API specifications.
+
+## Resource Listing
+
+The first part is a listing of the REST APIs.
+
+- http://localhost:3000/swagger/resources
+
+```javascript
+    {
+      "swaggerVersion": "1.1",
+      "basePath": "http://localhost:3000",
+      "apis": [
+        {
+          "path": "/swagger/ammo"
+        },
+        {
+          "path": "/swagger/customers"
+        },
+        {
+          "path": "/swagger/inventory"
+        },
+        {
+          "path": "/swagger/locations"
+        },
+        {
+          "path": "/swagger/weapons"
+        }
+      ]
+    }
+```
+
+## Resource Operations
+
+The second part describes all operations of a given model.
+
+- http://localhost:3000/swagger/locations
+
+```javascript
+    {
+      "swaggerVersion": "1.1",
+      "basePath": "http://localhost:3000",
+      "apis": [
+        {
+          "path": "/locations",
+          "operations": [
+            {
+              "httpMethod": "POST",
+              "nickname": "locations_create",
+              "responseClass": "object",
+              "parameters": [
+                {
+                  "paramType": "body",
+                  "name": "data",
+                  "description": "Model instance data",
+                  "dataType": "object",
+                  "required": false,
+                  "allowMultiple": false
+                }
+              ],
+              "errorResponses": [],
+              "summary": "Create a new instance of the model and persist it into the data source",
+              "notes": ""
+            }
+          ]
+        },
+        ...
+        {
+          "path": "/locations/{id}",
+          "operations": [
+            {
+              "httpMethod": "GET",
+              "nickname": "locations_findById",
+              "responseClass": "any",
+              "parameters": [
+                {
+                  "paramType": "path",
+                  "name": "id",
+                  "description": "Model id",
+                  "dataType": "any",
+                  "required": true,
+                  "allowMultiple": false
+                }
+              ],
+              "errorResponses": [],
+              "summary": "Find a model instance by id from the data source",
+              "notes": ""
+            }
+          ]
+        },
+        ...
+      ]
+    }
+```