Function createProxyApp

packages/cli/src/actions/proxy.ts:259–302

(
    client: ClientContract<SchemaDef>,
    schema: SchemaDef,
    authDb: ClientContract<SchemaDef>,
    auth?: {
        studioAuthKey: string;
        /** Seconds within which a signed request is considered valid. Defaults to 60. */
        signatureToleranceSecs: number;
    },
)

}

export function createProxyApp(
    client: ClientContract<SchemaDef>,
    schema: SchemaDef,
    authDb: ClientContract<SchemaDef>,
    auth?: {
        studioAuthKey: string;
        /** Seconds within which a signed request is considered valid. Defaults to 60. */
        signatureToleranceSecs: number;
    },
): express.Application {
    const app = express();
    app.use(cors());
    app.use(
        express.json({
            limit: '5mb',
            verify: (req, _res, buf) => {
                // Capture the raw body string for use in signature verification.
                (req as express.Request & { rawBody?: string }).rawBody = buf.toString('utf8');
            },
        }),
    );
    app.use(express.urlencoded({ extended: true, limit: '5mb' }));

    if (auth?.studioAuthKey) {
        // Apply signature-verification middleware to all authenticated endpoints.
        const toleranceSecs = auth.signatureToleranceSecs;
        const normalizedKey = normalizePublicKey(auth.studioAuthKey);
        app.use(['/api/model', '/api/schema'], createSignatureMiddleware(normalizedKey, toleranceSecs));
    }

    app.use(
        '/api/model',
        ZenStackMiddleware({
            apiHandler: new RPCApiHandler({ schema }),
            getClient: (req) => resolveClient(client, authDb, req, !!auth?.studioAuthKey),
        }),
    );

    app.get('/api/schema', (_req, res: express.Response) => {
        res.json({ ...schema, zenstackVersion: getVersion() });
    });

    return app;
}

/**
 * Creates an Express middleware that verifies the ed25519 signature on every request.