@arkstack/common 0.5.1 → 0.5.3

package/dist/app.d.ts

@@ -1,8 +1,58 @@
-import { GlobalConfig, GlobalEnv } from './'
+import type { GlobalConfig, GlobalEnv } from '.'
+
+interface Stubs {
+  api: string;
+  model: string;
+  resource: string;
+  controller: string;
+  collection: string;
+  apiResource: string;
+}
 
 declare global {
   var env: GlobalEnv
   var config: GlobalConfig
+
+  /**
+   * Thows to abort the current request
+   * 
+   * @param message 
+   * @param code 
+   * @throws {RequestException}
+   */
+  function abort (
+    message?: string,
+    code?: number
+  ): void
+
+  /**
+   * Asserts that a boolean condition is true. 
+   * 
+   * @param boolean 
+   * @param message 
+   * @param code 
+   * @throws {RequestException} Throws if the boolean condition is true.
+   */
+  function abortIf<T> (
+    boolean: T,
+    message?: string,
+    code?: number,
+  ): asserts  boolean is T
+
+  /**
+   * Asserts that a value is not null or undefined. 
+   * 
+   * @param value 
+   * @param message 
+   * @param code 
+   * @throws {RequestException} Throws if the value is null or undefined.
+   */
+  function assertFound<T> (
+    value: T | null | undefined,
+    message: string,
+    code: number = 404,
+  ): asserts value is T
+
   interface String {
     /**
      * Converts the string to title case.
@@ -27,4 +77,14 @@ declare global {
   }
 }
 
+declare module 'resora' {
+  interface Config {
+    stubs: Stubs;
+  }
+
+  interface ResoraConfig {
+    stubs?: Partial<Stubs> | undefined
+  }
+}
+
 export { }

package/dist/faker.d.ts

@@ -0,0 +1,9 @@
+import { Faker, ImageModule } from "@faker-js/faker";
+import { PictwoFakerImage } from "@pictwo/faker";
+
+//#region src/faker.d.ts
+declare const faker: Faker & {
+  image: ImageModule & PictwoFakerImage;
+};
+//#endregion
+export { faker };

package/dist/faker.js

@@ -0,0 +1,20 @@
+import { v as configLoader } from "./system-DUaI4u99.js";
+import * as fakerLocales from "@faker-js/faker";
+import { Faker } from "@faker-js/faker";
+import { pictwoImage } from "@pictwo/faker";
+//#region src/faker.ts
+const config = globalThis.config ?? ((key, def) => configLoader.resolve(key, def));
+const fallbackLocale = "en";
+const resolveLocale = () => {
+	const locale = config("app.locale", fallbackLocale);
+	if (typeof locale === "string" && locale in fakerLocales && typeof fakerLocales[locale] === "object") return fakerLocales[locale];
+	return fakerLocales[fallbackLocale];
+};
+const fakerInstance = new Faker({ locale: [resolveLocale()].filter(Boolean) });
+const { faker: _, ...image } = fakerInstance.image;
+const faker = {
+	...fakerInstance,
+	image: Object.assign({}, image, pictwoImage())
+};
+//#endregion
+export { faker };

package/dist/helpers-BrQ0B-EX.d.ts

@@ -0,0 +1,109 @@
+import { TOTP } from "otpauth";
+import { Model, ModelStatic } from "arkormx";
+
+//#region src/utils/encryption.d.ts
+declare class Encryption {
+  private static readonly algorithm;
+  private static getKey;
+  static encrypt(value: string): string;
+  static decrypt(payload: string): string;
+}
+//#endregion
+//#region src/utils/hash.d.ts
+declare class Hash {
+  /**
+   * Hash a value using bcrypt
+   *
+   * @param value
+   * @returns
+   */
+  static make(value: string): Promise<string>;
+  /**
+   * Verify a value against a hashed value
+   *
+   * @param value
+   * @param hashedValue
+   * @returns
+   */
+  static verify(value: string, hashedValue: string): Promise<boolean>;
+  /**
+   * Generate a one-time password (OTP) using TOTP algorithm
+   *
+   * @param digits    The number of digits for the OTP, default is 6.
+   * @param label     A label to identify the OTP, can be an email or phone number.
+   * @param period    Interval of time for which a token is valid, in seconds.
+   * @returns
+   */
+  static otp(digits?: number, label?: string, period?: number): TOTP;
+  static totp(secret: string, label: string, issuer?: string, period?: number): TOTP;
+}
+//#endregion
+//#region src/utils/helpers.d.ts
+type AbstractModelConstructor<TModel = unknown> = abstract new (attributes?: Record<string, unknown>) => TModel;
+type ModelConstructor<TModel extends Model = Model> = AbstractModelConstructor<TModel> & Pick<ModelStatic<TModel>, keyof ModelStatic<TModel>>;
+interface ModelRegistry {}
+type ModelName = Extract<keyof ModelRegistry, string>;
+/**
+ * Checks and asserts if target is a class
+ *
+ * @param target
+ * @returns
+ */
+declare const isClass: <T = unknown>(target: unknown) => target is new (...args: any[]) => T;
+/**
+ * Determine the number of items to return per page based on the provided query parameters.
+ *
+ * @param query
+ * @returns
+ */
+declare const perPage: (query: {
+  limit?: number;
+  perPage?: number;
+}) => number;
+/**
+ * Import an application model by name.
+ *
+ * Apps can augment `ModelRegistry` to make `getModel('User')` return `typeof User`.
+ * Without a registry entry, pass the class type explicitly: `getModel<typeof User>('User')`.
+ *
+ * @param modelName
+ */
+declare function getModel<TName extends ModelName>(modelName: TName): Promise<ModelRegistry[TName]>;
+declare function getModel<TModel extends AbstractModelConstructor = ModelConstructor>(modelName: string): Promise<TModel>;
+declare const initializeGlobalContext: ({
+  Request,
+  Response,
+  Session
+}?: {
+  Request?: any;
+  Response?: any;
+  Session?: any;
+}) => Promise<void>;
+/**
+ * Thows to abort the current request
+ *
+ * @param message
+ * @param code
+ * @throws {RequestException}
+ */
+declare const abort: (message?: string, code?: number) => void;
+/**
+ * Asserts that a boolean condition is true.
+ *
+ * @param boolean
+ * @param message
+ * @param code
+ * @throws {RequestException} Throws if the boolean condition is true.
+ */
+declare const abortIf: <T>(boolean: T, message?: string, code?: number) => asserts boolean is T;
+/**
+ * Asserts that a value is not null or undefined.
+ *
+ * @param value
+ * @param message
+ * @param code
+ * @throws {RequestException} Throws if the value is null or undefined.
+ */
+declare const assertFound: <T>(value: T | null | undefined, message: string, code?: number) => asserts value is T;
+//#endregion
+export { abortIf as a, initializeGlobalContext as c, Hash as d, Encryption as f, abort as i, isClass as l, ModelConstructor as n, assertFound as o, ModelRegistry as r, getModel as s, AbstractModelConstructor as t, perPage as u };