parse-server 2.8.4 → 8.6.2

package/types/Options/index.d.ts

@@ -0,0 +1,301 @@
+// This file is manually updated to match src/Options/index.js until typed
+import { AnalyticsAdapter } from '../Adapters/Analytics/AnalyticsAdapter';
+import { CacheAdapter } from '../Adapters/Cache/CacheAdapter';
+import { MailAdapter } from '../Adapters/Email/MailAdapter';
+import { FilesAdapter } from '../Adapters/Files/FilesAdapter';
+import { LoggerAdapter } from '../Adapters/Logger/LoggerAdapter';
+import { PubSubAdapter } from '../Adapters/PubSub/PubSubAdapter';
+import { StorageAdapter } from '../Adapters/Storage/StorageAdapter';
+import { WSSAdapter } from '../Adapters/WebSocketServer/WSSAdapter';
+import { CheckGroup } from '../Security/CheckGroup';
+export interface SchemaOptions {
+    definitions: any;
+    strict?: boolean;
+    deleteExtraFields?: boolean;
+    recreateModifiedFields?: boolean;
+    lockSchemas?: boolean;
+    beforeMigration?: () => void | Promise<void>;
+    afterMigration?: () => void | Promise<void>;
+}
+type Adapter<T> = string | T;
+type NumberOrBoolean = number | boolean;
+type NumberOrString = number | string;
+type ProtectedFields = any;
+type StringOrStringArray = string | string[];
+type RequestKeywordDenylist = {
+    key: string;
+    value: any;
+};
+export interface ParseServerOptions {
+    appId: string;
+    masterKey: (() => void) | string;
+    masterKeyTtl?: number;
+    maintenanceKey: string;
+    serverURL: string;
+    masterKeyIps?: (string[]);
+    maintenanceKeyIps?: (string[]);
+    appName?: string;
+    allowHeaders?: (string[]);
+    allowOrigin?: StringOrStringArray;
+    analyticsAdapter?: Adapter<AnalyticsAdapter>;
+    filesAdapter?: Adapter<FilesAdapter>;
+    push?: any;
+    scheduledPush?: boolean;
+    loggerAdapter?: Adapter<LoggerAdapter>;
+    jsonLogs?: boolean;
+    logsFolder?: string;
+    verbose?: boolean;
+    logLevel?: string;
+    logLevels?: LogLevels;
+    maxLogFiles?: NumberOrString;
+    silent?: boolean;
+    databaseURI: string;
+    databaseOptions?: DatabaseOptions;
+    databaseAdapter?: Adapter<StorageAdapter>;
+    enableCollationCaseComparison?: boolean;
+    convertEmailToLowercase?: boolean;
+    convertUsernameToLowercase?: boolean;
+    cloud?: string;
+    collectionPrefix?: string;
+    clientKey?: string;
+    javascriptKey?: string;
+    dotNetKey?: string;
+    encryptionKey?: string;
+    restAPIKey?: string;
+    readOnlyMasterKey?: string;
+    webhookKey?: string;
+    fileKey?: string;
+    preserveFileName?: boolean;
+    userSensitiveFields?: (string[]);
+    protectedFields?: ProtectedFields;
+    enableAnonymousUsers?: boolean;
+    allowClientClassCreation?: boolean;
+    allowCustomObjectId?: boolean;
+    auth?: Record<string, AuthAdapter>;
+    enableInsecureAuthAdapters?: boolean;
+    maxUploadSize?: string;
+    verifyUserEmails?: (boolean | void);
+    preventLoginWithUnverifiedEmail?: boolean;
+    preventSignupWithUnverifiedEmail?: boolean;
+    emailVerifyTokenValidityDuration?: number;
+    emailVerifyTokenReuseIfValid?: boolean;
+    sendUserEmailVerification?: (boolean | void);
+    accountLockout?: AccountLockoutOptions;
+    passwordPolicy?: PasswordPolicyOptions;
+    cacheAdapter?: Adapter<CacheAdapter>;
+    emailAdapter?: Adapter<MailAdapter>;
+    encodeParseObjectInCloudFunction?: boolean;
+    publicServerURL?: string | (() => string) | (() => Promise<string>);
+    pages?: PagesOptions;
+    customPages?: CustomPagesOptions;
+    liveQuery?: LiveQueryOptions;
+    sessionLength?: number;
+    extendSessionOnUse?: boolean;
+    defaultLimit?: number;
+    maxLimit?: number;
+    expireInactiveSessions?: boolean;
+    revokeSessionOnPasswordReset?: boolean;
+    cacheTTL?: number;
+    cacheMaxSize?: number;
+    directAccess?: boolean;
+    enableExpressErrorHandler?: boolean;
+    objectIdSize?: number;
+    port?: number;
+    host?: string;
+    mountPath?: string;
+    cluster?: NumberOrBoolean;
+    middleware?: ((() => void) | string);
+    trustProxy?: any;
+    startLiveQueryServer?: boolean;
+    liveQueryServerOptions?: LiveQueryServerOptions;
+    idempotencyOptions?: IdempotencyOptions;
+    fileUpload?: FileUploadOptions;
+    graphQLSchema?: string;
+    mountGraphQL?: boolean;
+    graphQLPath?: string;
+    mountPlayground?: boolean;
+    playgroundPath?: string;
+    schema?: SchemaOptions;
+    serverCloseComplete?: () => void;
+    security?: SecurityOptions;
+    enforcePrivateUsers?: boolean;
+    allowExpiredAuthDataToken?: boolean;
+    requestKeywordDenylist?: (RequestKeywordDenylist[]);
+    rateLimit?: (RateLimitOptions[]);
+    verifyServerUrl?: boolean;
+}
+export interface RateLimitOptions {
+    requestPath: string;
+    requestTimeWindow?: number;
+    requestCount?: number;
+    errorResponseMessage?: string;
+    requestMethods?: (string[]);
+    includeMasterKey?: boolean;
+    includeInternalRequests?: boolean;
+    redisUrl?: string;
+    zone?: string;
+}
+export interface SecurityOptions {
+    enableCheck?: boolean;
+    enableCheckLog?: boolean;
+    checkGroups?: (CheckGroup[]);
+}
+export interface PagesOptions {
+    enableRouter?: boolean;
+    enableLocalization?: boolean;
+    localizationJsonPath?: string;
+    localizationFallbackLocale?: string;
+    placeholders?: any;
+    forceRedirect?: boolean;
+    pagesPath?: string;
+    pagesEndpoint?: string;
+    customUrls?: PagesCustomUrlsOptions;
+    customRoutes?: (PagesRoute[]);
+}
+export interface PagesRoute {
+    path: string;
+    method: string;
+    handler: () => void;
+}
+export interface PagesCustomUrlsOptions {
+    passwordReset?: string;
+    passwordResetLinkInvalid?: string;
+    passwordResetSuccess?: string;
+    emailVerificationSuccess?: string;
+    emailVerificationSendFail?: string;
+    emailVerificationSendSuccess?: string;
+    emailVerificationLinkInvalid?: string;
+    emailVerificationLinkExpired?: string;
+}
+export interface CustomPagesOptions {
+    invalidLink?: string;
+    linkSendFail?: string;
+    choosePassword?: string;
+    linkSendSuccess?: string;
+    verifyEmailSuccess?: string;
+    passwordResetSuccess?: string;
+    invalidVerificationLink?: string;
+    expiredVerificationLink?: string;
+    invalidPasswordResetLink?: string;
+    parseFrameURL?: string;
+}
+export interface LiveQueryOptions {
+    classNames?: (string[]);
+    redisOptions?: any;
+    redisURL?: string;
+    pubSubAdapter?: Adapter<PubSubAdapter>;
+    wssAdapter?: Adapter<WSSAdapter>;
+}
+export interface LiveQueryServerOptions {
+    appId?: string;
+    masterKey?: string;
+    serverURL?: string;
+    keyPairs?: any;
+    websocketTimeout?: number;
+    cacheTimeout?: number;
+    logLevel?: string;
+    port?: number;
+    redisOptions?: any;
+    redisURL?: string;
+    pubSubAdapter?: Adapter<PubSubAdapter>;
+    wssAdapter?: Adapter<WSSAdapter>;
+}
+export interface IdempotencyOptions {
+    paths?: (string[]);
+    ttl?: number;
+}
+export interface AccountLockoutOptions {
+    duration?: number;
+    threshold?: number;
+    unlockOnPasswordReset?: boolean;
+}
+export interface PasswordPolicyOptions {
+    validatorPattern?: string;
+    validatorCallback?: () => void;
+    validationError?: string;
+    doNotAllowUsername?: boolean;
+    maxPasswordAge?: number;
+    maxPasswordHistory?: number;
+    resetTokenValidityDuration?: number;
+    resetTokenReuseIfValid?: boolean;
+    resetPasswordSuccessOnInvalidEmail?: boolean;
+}
+export interface FileUploadOptions {
+    fileExtensions?: (string[]);
+    enableForAnonymousUser?: boolean;
+    enableForAuthenticatedUser?: boolean;
+    enableForPublic?: boolean;
+}
+export interface DatabaseOptions {
+    // Parse Server custom options
+    allowPublicExplain?: boolean;
+    createIndexRoleName?: boolean;
+    createIndexUserEmail?: boolean;
+    createIndexUserEmailCaseInsensitive?: boolean;
+    createIndexUserEmailVerifyToken?: boolean;
+    createIndexUserPasswordResetToken?: boolean;
+    createIndexUserUsername?: boolean;
+    createIndexUserUsernameCaseInsensitive?: boolean;
+    disableIndexFieldValidation?: boolean;
+    enableSchemaHooks?: boolean;
+    logClientEvents?: any[];
+    // maxTimeMS is a MongoDB option but Parse Server applies it per-operation, not as a global client option
+    maxTimeMS?: number;
+    schemaCacheTtl?: number;
+
+    // MongoDB driver options
+    appName?: string;
+    authMechanism?: string;
+    authMechanismProperties?: any;
+    authSource?: string;
+    autoSelectFamily?: boolean;
+    autoSelectFamilyAttemptTimeout?: number;
+    compressors?: string[] | string;
+    connectTimeoutMS?: number;
+    directConnection?: boolean;
+    forceServerObjectId?: boolean;
+    heartbeatFrequencyMS?: number;
+    loadBalanced?: boolean;
+    localThresholdMS?: number;
+    maxConnecting?: number;
+    maxIdleTimeMS?: number;
+    maxPoolSize?: number;
+    maxStalenessSeconds?: number;
+    minPoolSize?: number;
+    proxyHost?: string;
+    proxyPassword?: string;
+    proxyPort?: number;
+    proxyUsername?: string;
+    readConcernLevel?: string;
+    readPreference?: string;
+    readPreferenceTags?: any[];
+    replicaSet?: string;
+    retryReads?: boolean;
+    retryWrites?: boolean;
+    serverMonitoringMode?: string;
+    serverSelectionTimeoutMS?: number;
+    socketTimeoutMS?: number;
+    srvMaxHosts?: number;
+    srvServiceName?: string;
+    ssl?: boolean;
+    tls?: boolean;
+    tlsAllowInvalidCertificates?: boolean;
+    tlsAllowInvalidHostnames?: boolean;
+    tlsCAFile?: string;
+    tlsCertificateKeyFile?: string;
+    tlsCertificateKeyFilePassword?: string;
+    tlsInsecure?: boolean;
+    waitQueueTimeoutMS?: number;
+    zlibCompressionLevel?: number;
+}
+export interface AuthAdapter {
+    enabled?: boolean;
+}
+export interface LogLevels {
+    triggerAfter?: string;
+    triggerBeforeSuccess?: string;
+    triggerBeforeError?: string;
+    cloudFunctionSuccess?: string;
+    cloudFunctionError?: string;
+}
+export {};

package/types/ParseServer.d.ts

@@ -0,0 +1,65 @@
+import { ParseServerOptions, LiveQueryServerOptions } from './Options';
+import { ParseLiveQueryServer } from './LiveQuery/ParseLiveQueryServer';
+declare class ParseServer {
+    _app: any;
+    config: any;
+    server: any;
+    expressApp: any;
+    liveQueryServer: any;
+    /**
+     * @constructor
+     * @param {ParseServerOptions} options the parse server initialization options
+     */
+    constructor(options: ParseServerOptions);
+    /**
+     * Starts Parse Server as an express app; this promise resolves when Parse Server is ready to accept requests.
+     */
+    start(): Promise<this>;
+    get app(): any;
+    /**
+     * Stops the parse server, cancels any ongoing requests and closes all connections.
+     *
+     * Currently, express doesn't shut down immediately after receiving SIGINT/SIGTERM
+     * if it has client connections that haven't timed out.
+     * (This is a known issue with node - https://github.com/nodejs/node/issues/2642)
+     *
+     * @returns {Promise<void>} a promise that resolves when the server is stopped
+     */
+    handleShutdown(): Promise<void>;
+    /**
+     * @static
+     * Allow developers to customize each request with inversion of control/dependency injection
+     */
+    static applyRequestContextMiddleware(api: any, options: any): void;
+    /**
+     * @static
+     * Create an express app for the parse server
+     * @param {Object} options let you specify the maxUploadSize when creating the express app  */
+    static app(options: any): any;
+    static promiseRouter({ appId }: {
+        appId: any;
+    }): any;
+    /**
+     * starts the parse server's express app
+     * @param {ParseServerOptions} options to use to start the server
+     * @returns {ParseServer} the parse server instance
+     */
+    startApp(options: ParseServerOptions): Promise<this>;
+    /**
+     * Creates a new ParseServer and starts it.
+     * @param {ParseServerOptions} options used to start the server
+     * @returns {ParseServer} the parse server instance
+     */
+    static startApp(options: ParseServerOptions): Promise<ParseServer>;
+    /**
+     * Helper method to create a liveQuery server
+     * @static
+     * @param {Server} httpServer an optional http server to pass
+     * @param {LiveQueryServerOptions} config options for the liveQueryServer
+     * @param {ParseServerOptions} options options for the ParseServer
+     * @returns {Promise<ParseLiveQueryServer>} the live query server instance
+     */
+    static createLiveQueryServer(httpServer: any, config: LiveQueryServerOptions, options: ParseServerOptions): Promise<ParseLiveQueryServer>;
+    static verifyServerUrl(): any;
+}
+export default ParseServer;

package/types/eslint.config.mjs

@@ -0,0 +1,30 @@
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import expectType from 'eslint-plugin-expect-type/configs/recommended';
+
+export default tseslint.config({
+  files: ['**/*.js', '**/*.ts'],
+  extends: [
+    expectType,
+    eslint.configs.recommended,
+    ...tseslint.configs.recommended,
+    ...tseslint.configs.recommendedTypeChecked,
+  ],
+  plugins: {
+    '@typescript-eslint': tseslint.plugin,
+  },
+  rules: {
+    '@typescript-eslint/no-unused-vars': 'off',
+    '@typescript-eslint/no-unused-expressions': 'off',
+    '@typescript-eslint/no-unsafe-call': 'off',
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/no-unsafe-return": "off",
+  },
+  languageOptions: {
+    parser: tseslint.parser,
+    parserOptions: {
+      projectService: true,
+      tsconfigRootDir: import.meta.dirname,
+    },
+  },
+});

package/types/index.d.ts

@@ -0,0 +1,21 @@
+import ParseServer from './ParseServer';
+import FileSystemAdapter from '@parse/fs-files-adapter';
+import InMemoryCacheAdapter from './Adapters/Cache/InMemoryCacheAdapter';
+import NullCacheAdapter from './Adapters/Cache/NullCacheAdapter';
+import RedisCacheAdapter from './Adapters/Cache/RedisCacheAdapter';
+import LRUCacheAdapter from './Adapters/Cache/LRUCache.js';
+import * as TestUtils from './TestUtils';
+import * as SchemaMigrations from './SchemaMigrations/Migrations';
+import AuthAdapter from './Adapters/Auth/AuthAdapter';
+import { PushWorker } from './Push/PushWorker';
+import { ParseServerOptions } from './Options';
+import { ParseGraphQLServer } from './GraphQL/ParseGraphQLServer';
+declare const _ParseServer: {
+    (options: ParseServerOptions): ParseServer;
+    createLiveQueryServer: typeof ParseServer.createLiveQueryServer;
+    startApp: typeof ParseServer.startApp;
+};
+declare const S3Adapter: any;
+declare const GCSAdapter: any;
+export default ParseServer;
+export { S3Adapter, GCSAdapter, FileSystemAdapter, InMemoryCacheAdapter, NullCacheAdapter, RedisCacheAdapter, LRUCacheAdapter, TestUtils, PushWorker, ParseGraphQLServer, _ParseServer as ParseServer, SchemaMigrations, AuthAdapter, };

package/types/logger.d.ts

@@ -0,0 +1,2 @@
+export declare function setLogger(aLogger: any): void;
+export declare function getLogger(): any;

package/types/tests.ts

@@ -0,0 +1,44 @@
+import ParseServer, { FileSystemAdapter } from 'parse-server';
+
+async function server() {
+  // $ExpectType ParseServer
+  const parseServer = await ParseServer.startApp({});
+
+  // $ExpectType void
+  await parseServer.handleShutdown();
+
+  // $ExpectType any
+  parseServer.app;
+
+  // $ExpectType any
+  ParseServer.app({});
+
+  // $ExpectType any
+  ParseServer.promiseRouter({ appId: 'appId' });
+
+  // $ExpectType ParseLiveQueryServer
+  await ParseServer.createLiveQueryServer({}, {}, {});
+
+  // $ExpectType any
+  ParseServer.verifyServerUrl();
+
+  // $ExpectError
+  await ParseServer.startApp();
+
+  // $ExpectError
+  ParseServer.promiseRouter();
+
+  // $ExpectError
+  await ParseServer.createLiveQueryServer();
+
+  // $ExpectType ParseServer
+  const parseServer2 = new ParseServer({});
+
+  // $ExpectType ParseServer
+  await parseServer2.start();
+}
+
+function exports() {
+  // $ExpectType any
+  FileSystemAdapter;
+}

package/types/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+      "module": "commonjs",
+      "lib": ["es6"],
+      "noImplicitAny": true,
+      "noImplicitThis": true,
+      "strictFunctionTypes": true,
+      "strictNullChecks": true,
+      "types": [],
+      "noEmit": true,
+      "forceConsistentCasingInFileNames": true,
+
+      // If the library is an external module (uses `export`), this allows your test file to import "mylib" instead of "./index".
+      // If the library is global (cannot be imported via `import` or `require`), leave this out.
+      "baseUrl": ".",
+      "paths": {
+        "parse-server": ["."],
+        "@parse/fs-files-adapter": ["./@types/@parse/fs-files-adapter"],
+      }
+  },
+  "include": [
+    "tests.ts"
+  ]
+}