@nlabs/reaktor 0.10.1 → 0.10.5

package/lib/types/users.types.d.ts

@@ -0,0 +1,110 @@
+/**
+ * Copyright (c) 2019-Present, Nitrogen Labs, Inc.
+ * Copyrights licensed under the MIT License. See the accompanying LICENSE file for terms.
+ */
+import type { QueryFilter } from './apps.types.js';
+import type { DocumentType } from './arangodb.types.js';
+import type { Locale } from './content.types.js';
+import type { TagType } from './tags.types.js';
+import type { Reaction } from '../actions/reactions.js';
+import type { UserAccess } from '../actions/users.js';
+export interface UserType extends DocumentType {
+    readonly active?: boolean;
+    readonly bankAccount?: string;
+    readonly bankFullName?: string;
+    readonly bankId?: string;
+    readonly bankRouting?: string;
+    readonly city?: string;
+    readonly country?: string;
+    readonly currency?: string;
+    readonly deviceToken?: string;
+    readonly dob?: number;
+    readonly email?: string;
+    readonly expires?: number;
+    readonly first?: string;
+    readonly gender?: string;
+    readonly imageId?: string;
+    readonly imageUrl?: string;
+    readonly ip?: string;
+    readonly last?: string;
+    readonly lastActive?: number;
+    readonly locale?: Locale;
+    readonly mailingList?: boolean;
+    readonly name?: string;
+    readonly password?: string;
+    readonly phone?: string;
+    readonly salt?: string;
+    readonly state?: string;
+    readonly street1?: string;
+    readonly street2?: string;
+    readonly stripeAccountId?: string;
+    readonly stripeCustomerId?: string;
+    readonly tags?: TagType[];
+    readonly thumbId?: string;
+    readonly thumbUrl?: string;
+    readonly timezone?: string;
+    readonly token?: string;
+    readonly type?: string;
+    readonly userAccess?: UserAccess;
+    readonly userId?: string;
+    readonly username?: string;
+    readonly verifiedEmail?: boolean;
+    readonly verifiedEmailCode?: number;
+    readonly verifiedEmailExpires?: number;
+    readonly verifiedPhone?: boolean;
+    readonly verifiedPhoneExpires?: number;
+    readonly verifiedSmsCode?: number;
+    readonly zip?: string;
+}
+export type UserPaymentType = {
+    readonly ssn?: string;
+};
+export type UserInput = {
+    readonly active?: boolean;
+    readonly bankAccount?: string;
+    readonly bankFullName?: string;
+    readonly bankId?: string;
+    readonly bankRouting?: string;
+    readonly city?: string;
+    readonly currency?: string;
+    readonly confirm?: string;
+    readonly country?: string;
+    readonly deviceToken?: string;
+    readonly dob?: number;
+    readonly email?: string;
+    readonly expires?: number;
+    readonly first?: string;
+    readonly gender?: string;
+    readonly imageId?: string;
+    readonly imageUrl?: string;
+    readonly ip?: string;
+    readonly last?: string;
+    readonly lastActive?: number;
+    readonly locale?: Locale;
+    readonly mailingList?: boolean;
+    readonly name?: string;
+    readonly password?: string;
+    readonly phone?: string;
+    readonly recaptcha?: string;
+    readonly state?: string;
+    readonly street1?: string;
+    readonly street2?: string;
+    readonly stripeAccountId?: string;
+    readonly stripeCustomerId?: string;
+    readonly tags?: TagType[];
+    readonly thumbId?: string;
+    readonly thumbUrl?: string;
+    readonly timezone?: string;
+    readonly userAccess?: UserAccess;
+    readonly userId?: string;
+    readonly username?: string;
+    readonly zip?: string;
+};
+export type UserReactionQuery = Reaction & {
+    readonly filters?: QueryFilter[];
+};
+export type PasscodeType = {
+    readonly passAttempt?: number;
+    readonly passExpires?: number;
+    readonly passcode?: string;
+};

package/lib/types/videos.types.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Copyright (c) 2019-Present, Nitrogen Labs, Inc.
+ * Copyrights licensed under the MIT License. See the accompanying LICENSE file for terms.
+ */
+import type { PutObjectCommandInput } from '@aws-sdk/client-s3';
+import type { ArangoDbCollection, EdgeType } from './arangodb.types.js';
+import type { FileType } from './files.types.js';
+export interface VideoType extends FileType {
+    readonly bucket?: string;
+    readonly durationMs?: number;
+    readonly externalId?: string;
+    readonly externalUrl?: string;
+    readonly height?: number;
+    readonly posterId?: string;
+    readonly provider?: 'youtube' | 'vimeo' | 'other';
+    readonly s3Options?: PutObjectCommandInput;
+    readonly streamType?: 'hls' | 'progressive';
+    readonly thumb?: string;
+    readonly fileType?: string;
+    readonly transcoded?: boolean;
+    readonly type?: 'video' | 'external';
+    readonly url?: string;
+    readonly videoId?: string;
+    readonly width?: number;
+}
+export type VideoUrlData = {
+    readonly bucket?: string;
+    readonly directory?: string;
+    readonly isThumb?: boolean;
+    readonly type?: ArangoDbCollection;
+    readonly typeId?: string;
+    readonly urlType?: 'dev' | 'public' | 'signed';
+    readonly videoDir?: string;
+    readonly videoId?: string;
+    readonly userId?: string;
+};
+export type VideoEdgeType = EdgeType & {
+    readonly itemId?: string;
+    readonly itemType?: ArangoDbCollection;
+    readonly videoId?: string;
+};
+export type VideoOptions = {
+    readonly from?: number;
+    readonly to?: number;
+    readonly type?: string;
+};

package/lib/types/websockets.types.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright (c) 2019-Present, Nitrogen Labs, Inc.
+ * Copyrights licensed under the MIT License. See the accompanying LICENSE file for terms.
+ */
+import type { DocumentType } from './arangodb.types.js';
+export interface WebsocketConnection {
+    _key: string;
+    socketId: string;
+    userId: string;
+}
+export interface WebsocketMessageType extends DocumentType {
+    readonly added?: number;
+    readonly content?: string;
+    readonly conversationId?: string;
+    readonly files?: string[];
+    readonly images?: string[];
+    readonly messageId?: string;
+    readonly modified?: number;
+    readonly read?: boolean;
+    readonly saved?: boolean;
+    readonly userId?: string;
+}

package/lib/utils/adapterUtils.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Copyright (c) 2025-Present, Nitrogen Labs, Inc.
+ * Copyrights licensed under the MIT License. See the accompanying LICENSE file for terms.
+ */
+export declare const removeEmptyKeys: (obj: any) => any;

package/lib/utils/analyticsUtils.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright (c) 2019-Present, Nitrogen Labs, Inc.
+ * Copyrights licensed under the MIT License. See the accompanying LICENSE file for terms.
+ */
+import type { ApiContext } from '../types/auth.types.js';
+export type ReaktorError = Error & {
+    readonly column?: number;
+    readonly line?: number;
+    readonly message?: string;
+    readonly source?: string;
+};
+export type ReaktorLogParams = {
+    readonly action?: string;
+    readonly category?: string;
+    readonly label?: string;
+    readonly params?: Record<string, unknown>;
+    readonly value?: string;
+};
+export declare const IsUserError: unique symbol;
+export declare class UserError extends Error {
+    constructor(...args: any[]);
+}
+export declare const logError: (params: ReaktorLogParams, error?: ReaktorError, context?: ApiContext) => Promise<unknown>;
+export declare const logException: (params: ReaktorLogParams, context: ApiContext) => Promise<unknown>;
+export declare const logInfo: (params: any) => void;

package/lib/utils/arangodbUtils.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Copyright (c) 2019-Present, Nitrogen Labs, Inc.
+ * Copyrights licensed under the MIT License. See the accompanying LICENSE file for terms.
+ */
+import { Database } from 'arangojs';
+import type { ArangoDbCollection, ArangoDbLimit } from '../types/arangodb.types.js';
+export declare const useDb: (databaseName?: string) => Database;
+export declare const collectionDetails: {
+    apps: {
+        collection: string;
+        key: string;
+    };
+    conversations: {
+        collection: string;
+        key: string;
+    };
+    files: {
+        collection: string;
+        key: string;
+    };
+    groups: {
+        collection: string;
+        key: string;
+    };
+    images: {
+        collection: string;
+        key: string;
+    };
+    locations: {
+        collection: string;
+        key: string;
+    };
+    messages: {
+        collection: string;
+        key: string;
+    };
+    notifications: {
+        collection: string;
+        key: string;
+    };
+    payments: {
+        collection: string;
+        key: string;
+    };
+    posts: {
+        collection: string;
+        key: string;
+    };
+    reactions: {
+        collection: string;
+        key: string;
+    };
+    subscriptions: {
+        collection: string;
+        key: string;
+    };
+    tags: {
+        collection: string;
+        key: string;
+    };
+    users: {
+        collection: string;
+        key: string;
+    };
+};
+export declare const getDocId: (collection: ArangoDbCollection, item: any) => string;
+export declare const getLimit: (start?: number, to?: number) => ArangoDbLimit;
+export declare const selectReactionCountByType: (objectType: string, objectKey: string, field: string, selects: any) => any;
+export declare const sortIds: (ids: string[], sort?: string) => string[];
+export declare const getGqlFields: (info: any) => string[];

package/lib/utils/authUtils.d.ts

@@ -0,0 +1,23 @@
+import type { AppStage } from '../types/apps.types.js';
+import type { ApiContext } from '../types/auth.types.js';
+export type LambdaDataContext = {
+    accountId: 'accountId';
+    readonly requestId: string;
+    readonly requestTimeEpoch: number;
+    readonly resourceId: string;
+    readonly resourcePath: string;
+    readonly stage: AppStage;
+};
+export type LambdaData = {
+    readonly body?: string | object;
+    readonly 'body-json'?: string;
+    readonly context?: LambdaDataContext;
+    readonly requestContext?: object;
+};
+export declare const getLambdaData: (data: LambdaData | string) => {
+    body: any;
+    context: {};
+};
+export declare const parseJsonData: (data: any) => any;
+export declare const isAuthenticated: (context: ApiContext, userId: string) => boolean;
+export declare const createContext: (context: ApiContext, event: any) => Promise<ApiContext>;

package/lib/utils/contextUtils.d.ts

@@ -0,0 +1,3 @@
+import type { APIGatewayEvent } from 'aws-lambda';
+import type { LanguageDetectionContext } from './languageDetection.js';
+export declare const extractLanguageContext: (event: APIGatewayEvent) => LanguageDetectionContext;

package/lib/utils/dbI18n.d.ts

@@ -0,0 +1,10 @@
+import type { ApiContext } from '../types/auth.types.js';
+import type { Locale } from '../types/content.types.js';
+export declare const dbI18n: (context: ApiContext, key: string, fallbackContent: string, locale?: Locale) => Promise<string>;
+export declare const dbI18nMultiple: (context: ApiContext, translations: Array<{
+    key: string;
+    fallback: string;
+    locale?: Locale;
+}>) => Promise<string[]>;
+export declare const dbI18nWithInterpolation: (context: ApiContext, key: string, fallbackContent: string, interpolation?: Record<string, any>, locale?: Locale) => Promise<string>;
+export declare const dbI18nBatch: (context: ApiContext, keys: string[], fallbackMap: Record<string, string>, locale?: Locale) => Promise<Record<string, string>>;

package/lib/utils/dbI18n.example.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright (c) 2025-Present, Nitrogen Labs, Inc.
+ * Copyrights licensed under the MIT License. See the accompanying LICENSE file for terms.
+ *
+ * Example usage of the database-driven i18n system
+ *
+ * This demonstrates how to use the new i18n utility that fetches
+ * translations from the database with fallback support.
+ */
+import type { ApiContext } from '../types/auth.types.js';
+import type { Locale } from '../types/content.types.js';
+export declare function sendWelcomeSMS(context: ApiContext, username: string, phoneNumber: string): Promise<string>;
+export declare function sendVerificationCode(context: ApiContext, code: string, locale?: Locale): Promise<string>;
+export declare function generateWelcomeEmail(context: ApiContext, username: string, locale?: Locale): Promise<{
+    subject: string;
+    body: string;
+}>;
+export declare function generateNotificationMessages(context: ApiContext, locale?: Locale): Promise<Record<string, string>>;
+export declare function getErrorMessage(context: ApiContext, errorCode: string, locale?: Locale): Promise<string>;
+export declare function getUserGreeting(context: ApiContext, userLocale?: string): Promise<string>;

package/lib/utils/googleTranslate.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Copyright (c) 2025-Present, Nitrogen Labs, Inc.
+ * Copyrights licensed under the MIT License. See the accompanying LICENSE file for terms.
+ */
+export declare const translateText: (text: string, targetLanguage: string, sourceLanguage?: string) => Promise<string>;
+export declare const translateBatch: (texts: string[], targetLanguage: string, sourceLanguage?: string) => Promise<string[]>;

package/lib/utils/graphqlUtils.d.ts

@@ -0,0 +1,10 @@
+import type { ApiContext } from '../types/auth.types.js';
+export declare const getRequestedFields: (info: any) => string[];
+export declare const enhanceContextWithFields: (baseContext: ApiContext) => (root: any, args: any, context: any, info: any) => {
+    fields: string[];
+    config?: import("../config.js").AppConfig;
+    context?: any;
+    databaseName?: string;
+    languageContext?: import("./languageDetection.js").LanguageDetectionContext;
+    session?: import("./sessionUtils.js").Session;
+};

package/lib/utils/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) 2019-Present, Nitrogen Labs, Inc.
+ * Copyrights licensed under the MIT License. See the accompanying LICENSE file for terms.
+ */
+export * from './adapterUtils.js';
+export * from './analyticsUtils.js';
+export * from './arangodbUtils.js';
+export * from './authUtils.js';
+export * from './contextUtils.js';
+export * from './dbI18n.js';
+export * from './googleTranslate.js';
+export * from './graphqlUtils.js';
+export * from './languageDetection.js';
+export * from './localeUtils.js';
+export * from './middlewareUtils.js';
+export * from './sessionUtils.js';
+export * from './templateUtils.js';
+export * from './translationQueue.js';

package/lib/utils/languageDetection.d.ts

@@ -0,0 +1,8 @@
+import type { Locale } from '../types/content.types.js';
+export interface LanguageDetectionContext {
+    acceptLanguage?: string;
+    ipCountry?: string;
+    phoneCountryCode?: string;
+    userPreference?: Locale;
+}
+export declare const detectLanguage: (context: LanguageDetectionContext) => Locale;

package/lib/utils/localeUtils.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) 2025-Present, Nitrogen Labs, Inc.
+ * Copyrights licensed under the MIT License. See the accompanying LICENSE file for terms.
+ */
+import type { Locale } from '../types/content.types.js';
+export declare const extractLanguage: (locale: string) => string;
+export declare const isRegionalLocale: (locale: string) => boolean;
+export declare const getFallbackChain: (locale: string) => string[];
+export declare const getPrimaryLanguages: () => string[];
+export declare const isValidLocale: (locale: string) => locale is Locale;
+export declare const getSupportedLocales: () => Locale[];

package/lib/utils/localeUtils.example.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Copyright (c) 2025-Present, Nitrogen Labs, Inc.
+ * Copyrights licensed under the MIT License. See the accompanying LICENSE file for terms.
+ */
+export declare const runLocaleExamples: () => Promise<void>;

package/lib/utils/middlewareUtils.d.ts

@@ -0,0 +1,2 @@
+import type { ApiContext } from '../types/auth.types.js';
+export declare const addFieldsToContext: (resolve: Function, parent: any, args: any, context: ApiContext, info: any) => any;

package/lib/utils/sessionUtils.d.ts

@@ -0,0 +1,18 @@
+export type Session = {
+    readonly errors?: string[];
+    readonly exp?: number;
+    readonly iat?: number;
+    readonly username?: string;
+    readonly userAccess?: number;
+    readonly userId: string;
+};
+export type SessionToken = {
+    readonly expires: number;
+    readonly issued: number;
+    readonly token: string;
+    readonly userId: string;
+    readonly username: string;
+};
+export declare const setSession: (session: Session) => string;
+export declare const getSession: (token: string) => Session;
+export declare const isAdminUser: (session?: Session) => boolean;

package/lib/utils/stripeUtils.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) 2025-Present, Nitrogen Labs, Inc.
+ * Copyrights licensed under the MIT License. See the accompanying LICENSE file for terms.
+ */
+import stripe from 'stripe';
+export declare const stripeApiVersion = "2025-09-30.clover";
+export declare const getStripeClient: () => stripe;

package/lib/utils/templateUtils.d.ts

@@ -0,0 +1,3 @@
+export type TemplateParams = Record<string, string>;
+export declare const parseTemplate: (template: string, params: TemplateParams) => string;
+export declare const createTemplate: <T extends TemplateParams>(templateString: string, params: T) => string;

package/lib/utils/testUtils.d.ts

@@ -0,0 +1,95 @@
+/**
+ * Copyright (c) 2025-Present, Nitrogen Labs, Inc.
+ * Copyrights licensed under the MIT License. See the accompanying LICENSE file for terms.
+ */
+import { jest } from '@jest/globals';
+import type { GraphQLResolveInfo } from 'graphql';
+import type { ApiContext } from '../types/auth.types.js';
+type MockOverrides = Partial<Record<string, unknown>>;
+type TestContext = Partial<ApiContext> & {
+    session?: Partial<{
+        userId: string;
+        username: string;
+        userAccess: number;
+    }>;
+};
+type TestArgs = Record<string, unknown>;
+type TestReturnValue = unknown;
+export declare const createMockContext: (overrides?: MockOverrides) => ApiContext;
+export declare const createMockResolveInfo: (fieldName?: string) => GraphQLResolveInfo;
+export declare const mockActionsModule: (modulePath: string, mockActions: Record<string, jest.Mock>) => Promise<void>;
+export declare const mockObjectType: (modulePath: string, typeName: string) => Promise<void>;
+export declare const createQueryTestSuite: (name: string, actionsPath: string, testCases: Array<{
+    name: string;
+    actionName: string;
+    args: TestArgs;
+    expectedCall: (context: TestContext, args: TestArgs) => TestArgs;
+    mockReturnValue: TestReturnValue;
+    errorCase?: boolean;
+}>) => void;
+export declare const createMutationTestSuite: (name: string, actionsPath: string, testCases: Array<{
+    name: string;
+    actionName: string;
+    args: TestArgs;
+    expectedCall: (context: TestContext, args: TestArgs) => TestArgs;
+    mockReturnValue: TestReturnValue;
+    requiresAuth?: boolean;
+    authUserId?: string;
+}>) => void;
+export declare const createIntegrationTestSuite: (name: string, actionsPath: string, objectTypePath: string, typeName: string, testCases: Array<{
+    name: string;
+    actionName: string;
+    args: TestArgs;
+    expectedCall: (context: TestContext, args: TestArgs) => TestArgs;
+    successReturnValue: TestReturnValue;
+    errorReturnValue: TestReturnValue;
+    testErrorCase: boolean;
+}>) => void;
+export declare const createMockUser: (overrides?: MockOverrides) => {
+    email: string;
+    firstName: string;
+    lastName: string;
+    userId: string;
+    username: string;
+};
+export declare const createMockPost: (overrides?: MockOverrides) => {
+    content: string;
+    createdAt: string;
+    postId: string;
+    userId: string;
+};
+export declare const createMockMessage: (overrides?: MockOverrides) => {
+    content: string;
+    conversationId: string;
+    createdAt: string;
+    messageId: string;
+    userId: string;
+};
+export declare const createMockReaction: (overrides?: MockOverrides) => {
+    createdAt: string;
+    postId: string;
+    reactionId: string;
+    type: string;
+    userId: string;
+};
+export declare const createMockTag: (overrides?: MockOverrides) => {
+    description: string;
+    name: string;
+    tagId: string;
+};
+export declare const setupCommonMocks: () => Promise<void>;
+export declare const clearAllMocks: () => void;
+export declare const createActionTestSuite: (name: string, actionsPath: string, testCases: Array<{
+    name: string;
+    actionName: string;
+    args: TestArgs;
+    mockQuery: jest.Mock;
+    expectedResult: TestReturnValue;
+}>) => void;
+export declare const createAdapterTestSuite: (name: string, adapterPath: string, testCases: any[]) => void;
+export declare const createUtilsTestSuite: (name: string, utilsPath: string, testCases: Array<{
+    name: string;
+    input: TestArgs;
+    expectedOutput: TestReturnValue;
+}>) => void;
+export {};

package/lib/utils/translationQueue.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Copyright (c) 2025-Present, Nitrogen Labs, Inc.
+ * Copyrights licensed under the MIT License. See the accompanying LICENSE file for terms.
+ */
+import type { ApiContext } from '../types/auth.types.js';
+import type { Locale } from '../types/content.types.js';
+interface TranslationObject {
+    key: string;
+    fallback?: string;
+    params?: Record<string, any>;
+}
+declare class TranslationQueue {
+    private batches;
+    private batchTimeout;
+    private maxBatchSize;
+    translate(context: ApiContext, translations: TranslationObject[], locale?: Locale): Promise<Record<string, string>>;
+    private getTranslation;
+    flush(): Promise<void>;
+    clear(): void;
+    private getBatchKey;
+    private processBatch;
+    private interpolate;
+}
+declare const translationQueue: TranslationQueue;
+export declare const i18n: (context: ApiContext, translations: TranslationObject[], locale?: Locale) => Promise<Record<string, string>>;
+export declare const flush: () => Promise<void>;
+export declare const clear: () => void;
+export type { TranslationObject };
+export { translationQueue };

package/lib/utils/translationQueue.example.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright (c) 2025-Present, Nitrogen Labs, Inc.
+ * Copyrights licensed under the MIT License. See the accompanying LICENSE file for terms.
+ *
+ * Example usage of the translation queue system with Google Translate integration
+ *
+ * This demonstrates how to use the new translation queue that automatically
+ * translates content using Google Translate API when needed.
+ */
+import type { ApiContext } from '../types/auth.types.js';
+import type { Locale } from '../types/content.types.js';
+export declare function getWelcomeMessages(context: ApiContext, locale?: Locale): Promise<Record<string, string>>;
+export declare function getPersonalizedMessages(context: ApiContext, username: string, locale?: Locale): Promise<Record<string, string>>;
+export declare function getMultiLanguageContent(context: ApiContext): Promise<Record<Locale, Record<string, string>>>;
+export declare function getRobustTranslations(context: ApiContext, locale?: Locale): Promise<Record<string, string>>;
+export declare function processLargeTranslationBatch(context: ApiContext, locale?: Locale): Promise<Record<string, string>>;
+export declare function getErrorMessages(context: ApiContext, errorCode: string, locale?: Locale): Promise<Record<string, string>>;
+export declare function generateEmailTemplate(context: ApiContext, userData: {
+    name: string;
+    email: string;
+    orderId: string;
+    total: number;
+    items: number;
+}, locale?: Locale): Promise<{
+    subject: string;
+    greeting: string;
+    body: string;
+    footer: string;
+}>;
+export declare function getNotificationMessages(context: ApiContext, locale?: Locale): Promise<Record<string, string>>;
+export declare function performanceComparison(context: ApiContext): Promise<Record<string, string>>;
+export declare function getUserGreeting(context: ApiContext, userLocale?: string, username?: string): Promise<string>;
+export declare function ensureAllTranslationsProcessed(): Promise<void>;