Skip to content

fix: Add server-side Cloud Code types for parse/node #2855

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hajjarjoseph wants to merge 9 commits into
base: alpha
Choose a base branch
from
Open

fix: Add server-side Cloud Code types for parse/node #2855

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
2b70e4a
fix: Add server-side Cloud Code types for parse/node
hajjarjoseph Jan 7, 2026
51fab0a
fix: Add missing generic and export in node.d.ts
hajjarjoseph Jan 7, 2026
08766ab
fix: Add missing exports and context property to find requests
hajjarjoseph Jan 7, 2026
b09807b
refactor: Move Cloud types to source and add comprehensive tests
hajjarjoseph Jan 8, 2026
0cc5c26
fix: ESLint errors in Cloud Code tests
hajjarjoseph Jan 8, 2026
62ff1f1
fix: ESLint errors in CloudCode.ts
hajjarjoseph Jan 8, 2026
17da4a8
refactor: Move JSDoc to functions and clean up Cloud Code tests
hajjarjoseph Jan 8, 2026
469b4db
fix: Add missing JSDoc params for sendEmail function
hajjarjoseph Jan 8, 2026
685cf2d
chore: Regenerate type definitions
hajjarjoseph Jan 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
309 changes: 309 additions & 0 deletions src/CloudCode.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,312 @@
import type ParseObject from './ParseObject';
import type ParseUser from './ParseUser';
import type ParseFile from './ParseFile';
import type ParseQuery from './ParseQuery';

// ============================================================================
// Request Interfaces
// ============================================================================
Copy link
Member

@dplewis dplewis Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would remove these type / style of comments.

Copy link
Contributor Author

@hajjarjoseph hajjarjoseph Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done


export interface FunctionRequest<T = Record<string, any>> {
installationId?: string;
master: boolean;
user?: ParseUser;
params: T;
ip: string;
headers: Record<string, string>;
log: any;
functionName: string;
context: Record<string, unknown>;
config: any;
}

export interface FunctionResponse {
success: (result?: any) => void;
error: (message?: string) => void;
status: (code: number) => FunctionResponse;
header: (name: string, value: string) => FunctionResponse;
}

export interface TriggerRequest<T extends ParseObject = ParseObject> {
installationId?: string;
master: boolean;
isChallenge: boolean;
user?: ParseUser;
object: T;
original?: T;
ip: string;
headers: Record<string, string>;
triggerName: string;
log: any;
context: Record<string, unknown>;
config: any;
}

export interface BeforeSaveRequest<T extends ParseObject = ParseObject> extends TriggerRequest<T> {}

Check failure on line 45 in src/CloudCode.ts

View workflow job for this annotation

GitHub Actions / Lint 

An interface declaring no members is equivalent to its supertype
export interface AfterSaveRequest<T extends ParseObject = ParseObject> extends TriggerRequest<T> {}

Check failure on line 46 in src/CloudCode.ts

View workflow job for this annotation

GitHub Actions / Lint 

An interface declaring no members is equivalent to its supertype
export interface BeforeDeleteRequest<T extends ParseObject = ParseObject> extends TriggerRequest<T> {}

Check failure on line 47 in src/CloudCode.ts

View workflow job for this annotation

GitHub Actions / Lint 

An interface declaring no members is equivalent to its supertype
export interface AfterDeleteRequest<T extends ParseObject = ParseObject> extends TriggerRequest<T> {}

Check failure on line 48 in src/CloudCode.ts

View workflow job for this annotation

GitHub Actions / Lint 

An interface declaring no members is equivalent to its supertype

export interface BeforeFindRequest<T extends ParseObject = ParseObject> {
installationId?: string;
master: boolean;
user?: ParseUser;
query: ParseQuery<T>;
ip: string;
headers: Record<string, string>;
triggerName: string;
log: any;
isGet: boolean;
config: any;
context: Record<string, unknown>;
readPreference?: string;
count?: boolean;
}

export interface AfterFindRequest<T extends ParseObject = ParseObject> {
installationId?: string;
master: boolean;
user?: ParseUser;
query: ParseQuery<T>;
results: T[];
ip: string;
headers: Record<string, string>;
triggerName: string;
log: any;
config: any;
context: Record<string, unknown>;
}

export interface FileTriggerRequest {
installationId?: string;
master: boolean;
user?: ParseUser;
file: ParseFile;
fileSize: number;
contentLength: number;
ip: string;
headers: Record<string, string>;
triggerName: string;
log: any;
config: any;
}

export interface ConnectTriggerRequest {
installationId?: string;
useMasterKey: boolean;
user?: ParseUser;
clients: number;
subscriptions: number;
sessionToken?: string;
}

export interface LiveQueryEventTrigger<T extends ParseObject = ParseObject> {
installationId?: string;
useMasterKey: boolean;
user?: ParseUser;
sessionToken?: string;
event: string;
object: T;
original?: T;
clients: number;
subscriptions: number;
sendEvent: boolean;
}

export interface JobRequest {
params: Record<string, any>;
message: (message: string) => void;
config: any;
}

// ============================================================================
// Validator Types
// ============================================================================

export interface ValidatorField {
type?: any;
constant?: boolean;
default?: any;
options?: any[] | (() => any[]) | any;
required?: boolean;
error?: string;
}

export interface ValidatorObject {
requireUser?: boolean;
requireMaster?: boolean;
validateMasterKey?: boolean;
skipWithMasterKey?: boolean;
requireAnyUserRoles?: string[] | (() => string[]);
requireAllUserRoles?: string[] | (() => string[]);
requireUserKeys?: string[] | Record<string, ValidatorField>;
fields?: string[] | Record<string, ValidatorField>;
rateLimit?: {
requestPath?: string;
requestMethods?: string | string[];
requestTimeWindow?: number;
requestCount?: number;
errorResponseMessage?: string;
includeInternalRequests?: boolean;
includeMasterKey?: boolean;
};
}

// ============================================================================
// HTTP Types
// ============================================================================

export interface HTTPOptions {
body?: string | object;
error?: (response: HTTPResponse) => void;
followRedirects?: boolean;
headers?: Record<string, string>;
method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' | 'OPTIONS';
params?: string | Record<string, string>;
success?: (response: HTTPResponse) => void;
url: string;
}

export interface HTTPResponse {
buffer?: Buffer;
cookies?: Record<string, any>;
data?: any;
headers?: Record<string, string>;
status: number;
text?: string;
}

// ============================================================================
// Enum
// ============================================================================

export enum ReadPreferenceOption {
Primary = 'PRIMARY',
PrimaryPreferred = 'PRIMARY_PREFERRED',
Secondary = 'SECONDARY',
SecondaryPreferred = 'SECONDARY_PREFERRED',
Nearest = 'NEAREST',
}

// ============================================================================
// Function Declarations (server-side only, implemented by Parse Server)
// ============================================================================

export declare function define<T extends Record<string, any> = Record<string, any>>(
name: string,
handler: (request: FunctionRequest<T>) => any,
validator?: ValidatorObject | ((request: FunctionRequest<T>) => any)
): void;

export declare function define<T extends Record<string, any> = Record<string, any>>(
name: string,
handler: (request: FunctionRequest<T>, response: FunctionResponse) => any,

Check failure on line 203 in src/CloudCode.ts

View workflow job for this annotation

GitHub Actions / Lint 

These overloads can be combined into one signature taking `(request: FunctionRequest<T>) => any | (request: FunctionRequest<T>, response: FunctionResponse) => any`
validator?: ValidatorObject | ((request: FunctionRequest<T>) => any)
): void;

export declare function job(name: string, handler: (request: JobRequest) => any): void;

export declare function beforeSave<T extends ParseObject = ParseObject>(
className: string | { new (): T },

Check failure on line 210 in src/CloudCode.ts

View workflow job for this annotation

GitHub Actions / Lint 

Type literal only has a call signature, you should use a function type instead
handler: (request: BeforeSaveRequest<T>) => T | void | Promise<T | void>,

Check failure on line 211 in src/CloudCode.ts

View workflow job for this annotation

GitHub Actions / Lint 

void is not valid as a constituent in a union type

Check failure on line 211 in src/CloudCode.ts

View workflow job for this annotation

GitHub Actions / Lint 

void is not valid as a constituent in a union type
validator?: ValidatorObject | ((request: BeforeSaveRequest<T>) => any)
): void;

export declare function afterSave<T extends ParseObject = ParseObject>(
className: string | { new (): T },

Check failure on line 216 in src/CloudCode.ts

View workflow job for this annotation

GitHub Actions / Lint 

Type literal only has a call signature, you should use a function type instead
handler: (request: AfterSaveRequest<T>) => void | Promise<void>,
validator?: ValidatorObject | ((request: AfterSaveRequest<T>) => any)
): void;

export declare function beforeDelete<T extends ParseObject = ParseObject>(
className: string | { new (): T },

Check failure on line 222 in src/CloudCode.ts

View workflow job for this annotation

GitHub Actions / Lint 

Type literal only has a call signature, you should use a function type instead
handler: (request: BeforeDeleteRequest<T>) => void | Promise<void>,
validator?: ValidatorObject | ((request: BeforeDeleteRequest<T>) => any)
): void;

export declare function afterDelete<T extends ParseObject = ParseObject>(
className: string | { new (): T },
handler: (request: AfterDeleteRequest<T>) => void | Promise<void>,
validator?: ValidatorObject | ((request: AfterDeleteRequest<T>) => any)
): void;

export declare function beforeFind<T extends ParseObject = ParseObject>(
className: string | { new (): T },
handler: (request: BeforeFindRequest<T>) => ParseQuery<T> | void | Promise<ParseQuery<T> | void>,
validator?: ValidatorObject | ((request: BeforeFindRequest<T>) => any)
): void;

export declare function afterFind<T extends ParseObject = ParseObject>(
className: string | { new (): T },
handler: (request: AfterFindRequest<T>) => T[] | void | Promise<T[] | void>,
validator?: ValidatorObject | ((request: AfterFindRequest<T>) => any)
): void;

export declare function beforeLogin(
handler: (request: TriggerRequest<ParseUser>) => void | Promise<void>,
validator?: ValidatorObject | ((request: TriggerRequest<ParseUser>) => any)
): void;

export declare function afterLogin(
handler: (request: TriggerRequest<ParseUser>) => void | Promise<void>
): void;

export declare function afterLogout(
handler: (request: TriggerRequest) => void | Promise<void>
): void;

export declare function beforePasswordResetRequest(
handler: (request: TriggerRequest<ParseUser>) => void | Promise<void>,
validator?: ValidatorObject | ((request: TriggerRequest<ParseUser>) => any)
): void;

export declare function beforeSaveFile(
handler: (request: FileTriggerRequest) => ParseFile | void | Promise<ParseFile | void>
): void;

export declare function afterSaveFile(
handler: (request: FileTriggerRequest) => void | Promise<void>
): void;

export declare function beforeDeleteFile(
handler: (request: FileTriggerRequest) => void | Promise<void>
): void;

export declare function afterDeleteFile(
handler: (request: FileTriggerRequest) => void | Promise<void>
): void;

export declare function beforeConnect(
handler: (request: ConnectTriggerRequest) => void | Promise<void>,
validator?: ValidatorObject | ((request: ConnectTriggerRequest) => any)
): void;

export declare function beforeSubscribe<T extends ParseObject = ParseObject>(
className: string | { new (): T },
handler: (request: TriggerRequest<T>) => void | Promise<void>,
validator?: ValidatorObject | ((request: TriggerRequest<T>) => any)
): void;

export declare function afterLiveQueryEvent<T extends ParseObject = ParseObject>(
className: string | { new (): T },
handler: (request: LiveQueryEventTrigger<T>) => void | Promise<void>,
validator?: ValidatorObject | ((request: LiveQueryEventTrigger<T>) => any)
): void;

export declare function sendEmail(data: {
from?: string;
to: string;
subject?: string;
text?: string;
html?: string;
}): Promise<void>;

export declare function httpRequest(options: HTTPOptions): Promise<HTTPResponse>;

// ============================================================================
// JSDoc Documentation (for documentation generation)
// ============================================================================
Copy link
Member

@dplewis dplewis Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you move the documentation to their approprate function and ensure jsdocs run and the docs are viewable?

Copy link
Contributor Author

@hajjarjoseph hajjarjoseph Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Moved JSDoc documentation directly above each function declaration in CloudCode.ts
  • Verified npm run docs runs successfully without errors


/**
* Defines a Cloud Function.
*
Expand Down
Loading