@loomcore/common 0.0.3 → 0.0.5

package/dist/errors/custom.error.d.ts

@@ -0,0 +1,6 @@
+import { IError } from '../models/error.interface.js';
+export declare abstract class CustomError extends Error {
+    abstract statusCode: number;
+    protected constructor(message: string);
+    abstract serializeErrors(): IError[];
+}

package/dist/errors/index.d.ts

@@ -0,0 +1,2 @@
+export * from './custom.error.js';
+export * from './validation.error.js';

package/dist/errors/validation.error.d.ts

@@ -0,0 +1,10 @@
+import { CustomError } from './custom.error.js';
+export declare class ValidationError extends CustomError {
+    statusCode: number;
+    protected validationError: any;
+    constructor(validationError: any);
+    serializeErrors(): {
+        message: string;
+        field?: string | undefined;
+    }[];
+}

package/dist/models/address.interface.d.ts

@@ -0,0 +1,11 @@
+export interface IAddress {
+    address1?: string;
+    address2?: string;
+    address3?: string;
+    city?: string;
+    state?: string;
+    postalCode?: string;
+    countryCode?: string;
+    description?: string;
+    formattedAddress?: string;
+}

package/dist/models/api-response.interface.d.ts

@@ -0,0 +1,8 @@
+import { IError } from './error.interface.js';
+export type IApiResponse<T> = {
+    success?: boolean;
+    status?: number;
+    errors?: IError[];
+    messages?: string[];
+    data?: T | null;
+};

package/dist/models/auditable.model.d.ts

@@ -0,0 +1,12 @@
+export interface IAuditable {
+    _created: Date;
+    _createdBy: string;
+    _updated: Date;
+    _updatedBy: string;
+}
+export declare const AuditableSchema: import("@sinclair/typebox").TObject<{
+    _created: import("@sinclair/typebox").TTransform<import("@sinclair/typebox").TString, Date>;
+    _createdBy: import("@sinclair/typebox").TString;
+    _updated: import("@sinclair/typebox").TTransform<import("@sinclair/typebox").TString, Date>;
+    _updatedBy: import("@sinclair/typebox").TString;
+}>;

package/dist/models/entity.model.d.ts

@@ -0,0 +1,8 @@
+export interface IEntity {
+    _id: string;
+    _orgId?: string;
+}
+export declare const EntitySchema: import("@sinclair/typebox").TObject<{
+    _id: import("@sinclair/typebox").TString;
+    _orgId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+}>;

package/dist/models/error.interface.d.ts

@@ -0,0 +1,4 @@
+export interface IError {
+    message: string;
+    field?: string;
+}

package/dist/models/geo-json.interface.d.ts

@@ -0,0 +1,12 @@
+export interface IGeoJSON<T> {
+    type: string;
+    features: IGeoJSONFeature<T>[];
+}
+export interface IGeoJSONFeature<T> {
+    type: string;
+    geometry: {
+        type: string;
+        coordinates: number[];
+    };
+    properties: T;
+}

package/dist/models/index.d.ts

@@ -0,0 +1,15 @@
+export * from './user.model.js';
+export * from './organization.model.js';
+export * from './user-context.model.js';
+export * from './entity.model.js';
+export * from './login-response.model.js';
+export * from './token-response.model.js';
+export * from './auditable.model.js';
+export * from './query-options.model.js';
+export * from './password-reset-token.interface.js';
+export * from './model-spec.interface.js';
+export * from './paged-result.interface.js';
+export * from './geo-json.interface.js';
+export * from './address.interface.js';
+export * from './error.interface.js';
+export * from './api-response.interface.js';

package/dist/models/login-response.model.d.ts

@@ -0,0 +1,18 @@
+import { ITokenResponse } from './token-response.model.js';
+import { IUserContext } from './user-context.model.js';
+export interface ILoginResponse {
+    tokens: ITokenResponse;
+    userContext: IUserContext;
+}
+export declare const LoginResponseSchema: import("@sinclair/typebox").TObject<{
+    tokens: import("@sinclair/typebox").TObject<{
+        accessToken: import("@sinclair/typebox").TString;
+        refreshToken: import("@sinclair/typebox").TString;
+        expiresOn: import("@sinclair/typebox").TNumber;
+    }>;
+    userContext: import("@sinclair/typebox").TObject<{
+        user: import("@sinclair/typebox").TObject<{}>;
+        _orgId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    }>;
+}>;
+export declare const LoginResponseSpec: import("./model-spec.interface.js").IModelSpec<import("@sinclair/typebox").TSchema>;

package/dist/models/model-spec.interface.d.ts

@@ -0,0 +1,15 @@
+import { TSchema } from '@sinclair/typebox';
+import { TypeCompiler } from '@sinclair/typebox/compiler';
+export interface IModelSpec<T extends TSchema = TSchema> {
+    schema: T;
+    partialSchema: TSchema;
+    fullSchema: T;
+    validator: ReturnType<typeof TypeCompiler.Compile>;
+    partialValidator: ReturnType<typeof TypeCompiler.Compile>;
+    fullValidator: ReturnType<typeof TypeCompiler.Compile>;
+    isAuditable?: boolean;
+    isMultiTenant?: boolean;
+    encode: <E>(entity: E, overrideSchema?: TSchema) => E;
+    decode: <E>(entity: E) => E;
+    clean: <E>(entity: E) => E;
+}

package/dist/models/organization.model.d.ts

@@ -0,0 +1,19 @@
+import { IAuditable } from './auditable.model.js';
+export interface IOrganization extends IAuditable {
+    _id: string;
+    name: string;
+    code: string;
+    description?: string;
+    status: number;
+    isMetaOrg: boolean;
+    authToken?: string;
+}
+export declare const OrganizationSchema: import("@sinclair/typebox").TObject<{
+    name: import("@sinclair/typebox").TString;
+    code: import("@sinclair/typebox").TString;
+    description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    status: import("@sinclair/typebox").TNumber;
+    isMetaOrg: import("@sinclair/typebox").TBoolean;
+    authToken: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+}>;
+export declare const OrganizationSpec: import("./model-spec.interface.js").IModelSpec<import("@sinclair/typebox").TSchema>;

package/dist/models/paged-result.interface.d.ts

@@ -0,0 +1,7 @@
+export interface IPagedResult<T> {
+    entities?: T[];
+    total?: number;
+    page?: number;
+    pageSize?: number;
+    totalPages?: number;
+}

package/dist/models/password-reset-token.interface.d.ts

@@ -0,0 +1,12 @@
+import { IEntity, IAuditable } from './index.js';
+export interface IPasswordResetToken extends IEntity, IAuditable {
+    email: string;
+    token: string;
+    expiresOn: number;
+}
+export declare const PasswordResetTokenSchema: import("@sinclair/typebox").TObject<{
+    email: import("@sinclair/typebox").TString;
+    token: import("@sinclair/typebox").TString;
+    expiresOn: import("@sinclair/typebox").TNumber;
+}>;
+export declare const PasswordResetTokenSpec: import("./model-spec.interface.js").IModelSpec<import("@sinclair/typebox").TSchema>;

package/dist/models/query-options.model.d.ts

@@ -0,0 +1,33 @@
+import { SortDirection } from '../types/sort-direction.type.js';
+export type Filter = {
+    eq?: string | number | boolean | Date;
+    ne?: string | number | boolean | Date;
+    any?: string[] | number[];
+    all?: string[] | number[];
+    lt?: number | Date;
+    lte?: number | Date;
+    gt?: number | Date;
+    gte?: number | Date;
+    startsWith?: string;
+    endsWith?: string;
+    contains?: string;
+};
+export interface IQueryOptions {
+    orderBy?: string;
+    sortDirection?: SortDirection;
+    page?: number;
+    pageSize?: number;
+    filters?: {
+        [key: string]: Filter;
+    };
+}
+export declare class QueryOptions implements IQueryOptions {
+    orderBy?: string;
+    sortDirection: SortDirection;
+    page: number;
+    pageSize: number;
+    filters?: {
+        [key: string]: Filter;
+    };
+    constructor(options?: IQueryOptions);
+}

package/dist/models/token-response.model.d.ts

@@ -0,0 +1,11 @@
+export interface ITokenResponse {
+    accessToken: string;
+    refreshToken: string;
+    expiresOn: number;
+}
+export declare const TokenResponseSchema: import("@sinclair/typebox").TObject<{
+    accessToken: import("@sinclair/typebox").TString;
+    refreshToken: import("@sinclair/typebox").TString;
+    expiresOn: import("@sinclair/typebox").TNumber;
+}>;
+export declare const TokenResponseSpec: import("./model-spec.interface.js").IModelSpec<import("@sinclair/typebox").TSchema>;

package/dist/models/user-context.model.d.ts

@@ -0,0 +1,11 @@
+import { IUser } from './user.model.js';
+export interface IUserContext {
+    user: IUser;
+    _orgId?: string;
+}
+export declare const EmptyUserContext: IUserContext;
+export declare const UserContextSchema: import("@sinclair/typebox").TObject<{
+    user: import("@sinclair/typebox").TObject<{}>;
+    _orgId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+}>;
+export declare const UserContextSpec: import("./model-spec.interface.js").IModelSpec<import("@sinclair/typebox").TSchema>;

package/dist/models/user.model.d.ts

@@ -0,0 +1,30 @@
+import { IAuditable } from './auditable.model.js';
+import { IEntity } from './entity.model.js';
+export interface IUser extends IAuditable, IEntity {
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    displayName?: string;
+    password: string;
+    roles?: string[];
+    _lastLoggedIn?: Date;
+    _lastPasswordChange?: Date;
+}
+export declare const UserPasswordSchema: import("@sinclair/typebox").TObject<{
+    password: import("@sinclair/typebox").TString;
+}>;
+export declare const passwordValidator: import("@sinclair/typebox/compiler").TypeCheck<import("@sinclair/typebox").TObject<{
+    password: import("@sinclair/typebox").TString;
+}>>;
+export declare const UserSchema: import("@sinclair/typebox").TObject<{
+    email: import("@sinclair/typebox").TString;
+    firstName: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    lastName: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    displayName: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    password: import("@sinclair/typebox").TString;
+    roles: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+    _lastLoggedIn: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TTransform<import("@sinclair/typebox").TString, Date>>;
+    _lastPasswordChange: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TTransform<import("@sinclair/typebox").TString, Date>>;
+}>;
+export declare const UserSpec: import("./model-spec.interface.js").IModelSpec<import("@sinclair/typebox").TSchema>;
+export declare const PublicUserSchema: import("@sinclair/typebox").TObject<{}>;

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export * from './sort-direction.type.js';

package/dist/types/sort-direction.type.d.ts

@@ -0,0 +1,3 @@
+export type SortDirection = 1 | -1 | 'asc' | 'desc' | 'ascending' | 'descending' | {
+    $meta: string;
+};

package/dist/utils/entity.utils.d.ts

@@ -0,0 +1,25 @@
+import { TSchema } from '@sinclair/typebox';
+import { TypeCompiler } from '@sinclair/typebox/compiler';
+import { ValueError } from '@sinclair/typebox/errors';
+import { IAuditable } from '../models/auditable.model.js';
+import { IModelSpec } from '../models/model-spec.interface.js';
+declare function getValidator(schema: TSchema): ReturnType<typeof TypeCompiler.Compile>;
+declare function getModelSpec<T extends TSchema>(schema: T, options?: {
+    isAuditable?: boolean;
+    isMultiTenant?: boolean;
+}): IModelSpec;
+declare function validate(validator: ReturnType<typeof TypeCompiler.Compile>, data: unknown): ValueError[] | null;
+declare function handleValidationResult(validationErrors: ValueError[] | null, methodName: string): void;
+declare function isValidObjectId(id: any): boolean;
+declare function isAuditable(entity: any): entity is IAuditable;
+declare function isDecimalMultipleOf(value: number, multipleOf: number, precision?: number): boolean;
+export declare const entityUtils: {
+    handleValidationResult: typeof handleValidationResult;
+    isValidObjectId: typeof isValidObjectId;
+    isAuditable: typeof isAuditable;
+    getValidator: typeof getValidator;
+    getModelSpec: typeof getModelSpec;
+    validate: typeof validate;
+    isDecimalMultipleOf: typeof isDecimalMultipleOf;
+};
+export {};

package/dist/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './entity.utils.js';

package/dist/validation/formats/date-time.d.ts

@@ -0,0 +1 @@
+export declare function IsDateTime(value: string, strictTimeZone?: boolean): boolean;

package/dist/validation/formats/date.d.ts

@@ -0,0 +1 @@
+export declare function IsDate(value: string): boolean;

package/dist/validation/formats/email.d.ts

@@ -0,0 +1 @@
+export declare function IsEmail(value: string): boolean;

package/dist/validation/formats/objectid.d.ts

@@ -0,0 +1 @@
+export declare function IsObjectId(value: string): boolean;

package/dist/validation/formats/time.d.ts

@@ -0,0 +1 @@
+export declare function IsTime(value: string, strictTimeZone?: boolean): boolean;

package/dist/validation/index.d.ts

@@ -0,0 +1,5 @@
+export * from './typebox-setup.js';
+export * from './typebox-extensions.js';
+export * from './formats/date.js';
+export * from './formats/time.js';
+export * from './formats/date-time.js';

package/dist/validation/typebox-extensions.d.ts

@@ -0,0 +1,13 @@
+import { Kind, TSchema, NumberOptions } from '@sinclair/typebox';
+export declare function TypeboxIsoDate(options?: object): import("@sinclair/typebox").TTransform<import("@sinclair/typebox").TString, Date>;
+export declare function TypeboxDate(options?: object): import("@sinclair/typebox").TTransform<import("@sinclair/typebox").TString, Date>;
+export declare function TypeboxObjectId(options?: object): import("@sinclair/typebox").TString;
+export interface TDecimal extends TSchema, NumberOptions {
+    [Kind]: 'Decimal';
+    type: 'number';
+    static: number;
+}
+export declare function TypeboxDecimal(options?: NumberOptions): TDecimal;
+export declare function TypeboxMoney(options?: NumberOptions): TDecimal;
+export declare function TypeboxPercentage(options?: NumberOptions): TDecimal;
+export declare function testMoneyType(): void;

package/dist/validation/typebox-setup.d.ts

@@ -0,0 +1,2 @@
+import './typebox-extensions.js';
+export declare const initializeTypeBox: () => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loomcore/common",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "private": false,
   "description": "Loom Core Models- common models, interfaces, types, and utils for Loom Core. All things common to both api and client apps.",
   "scripts": {
@@ -14,7 +14,10 @@
     "gar-login": "npx --yes google-artifactregistry-auth",
     "publishMe": "npm publish --access public",
     "pub": "npm-run-all -s add commit patch build push publishMe",
-    "auth-and-pub": "npm-run-all -s add commit patch build push gar-login publishMe"
+    "auth-and-pub": "npm-run-all -s add commit patch build push gar-login publishMe",
+    "test": "cross-env NODE_ENV=test vitest run",
+    "test:ci": "cross-env NODE_ENV=test vitest run --reporter=json --outputFile=test-results.json",
+    "test:watch": "cross-env NODE_ENV=test vitest"
   },
   "keywords": [],
   "author": "Tim Hardy",
@@ -42,6 +45,7 @@
   },
   "devDependencies": {
     "npm-run-all": "^4.1.5",
-    "typescript": "^5.8.3"
+    "typescript": "^5.8.3",
+    "vitest": "^3.0.9"
   }
 }