@fluixi/api 0.0.0-stage → 0.1.0-alpha.3

package/dist/index.d.ts

@@ -0,0 +1,34 @@
+/**
+ * `@fluixi/api`: schema-first API routes on top of `@fluixi/start`'s file-based API routes.
+ *
+ * @example
+ * ```ts
+ * // src/api/v1/projects/[id].ts
+ * import { route, notFound } from '@fluixi/api';
+ * import { z } from 'zod';
+ *
+ * export const GET = route({
+ *   params: z.object({ id: z.string().uuid() }),
+ *   response: z.object({ id: z.string(), name: z.string() }),
+ *   async handler({ params }) {
+ *     const project = await projects.find(params.id);
+ *     if (!project) throw notFound();
+ *     return project;
+ *   },
+ * });
+ * ```
+ */
+export { route, contractOf, setErrorReporter, CONTRACT, REVALIDATE_HEADER } from './route.js';
+export type { Guard, RouteContract, RouteHandler, RouteInput } from './route.js';
+export { ApiError, badRequest, unauthorized, forbidden, notFound, conflict, errorResponse, toApiError } from './errors.js';
+export type { ApiErrorBody, ValidationIssue } from './errors.js';
+export { readJson, readQuery, DEFAULT_BODY_LIMIT } from './input.js';
+export { createOpenApiDocument, openApiRoute, describedBy, includeDocument, setJsonSchemaConverter } from './openapi.js';
+export type { OpenApiInfo, DescribedRoute, JsonSchemaConverter } from './openapi.js';
+export { apiSecurity, securityHeaders, cors, originCheck, DEFAULT_SECURITY_HEADERS } from './security.js';
+export type { ApiSecurityOptions, CorsOptions, Origins, SecurityHeadersOptions } from './security.js';
+export { rateLimit, memoryRateLimitStore, postgresRateLimitStore } from './rate-limit.js';
+export type { RateLimitOptions, RateLimitStore, PostgresRateLimitOptions, SqlClient } from './rate-limit.js';
+export type { Middleware } from './middleware.js';
+export type { StandardSchemaV1 } from './standard-schema.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC9F,YAAY,EAAE,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAEjF,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC3H,YAAY,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAEjE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAErE,OAAO,EAAE,qBAAqB,EAAE,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACzH,YAAY,EAAE,WAAW,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAErF,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,IAAI,EAAE,WAAW,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AAC1G,YAAY,EAAE,kBAAkB,EAAE,WAAW,EAAE,OAAO,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AACtG,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAC1F,YAAY,EAAE,gBAAgB,EAAE,cAAc,EAAE,wBAAwB,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC7G,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD,YAAY,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/index.js

@@ -0,0 +1,26 @@
+/**
+ * `@fluixi/api`: schema-first API routes on top of `@fluixi/start`'s file-based API routes.
+ *
+ * @example
+ * ```ts
+ * // src/api/v1/projects/[id].ts
+ * import { route, notFound } from '@fluixi/api';
+ * import { z } from 'zod';
+ *
+ * export const GET = route({
+ *   params: z.object({ id: z.string().uuid() }),
+ *   response: z.object({ id: z.string(), name: z.string() }),
+ *   async handler({ params }) {
+ *     const project = await projects.find(params.id);
+ *     if (!project) throw notFound();
+ *     return project;
+ *   },
+ * });
+ * ```
+ */
+export { route, contractOf, setErrorReporter, CONTRACT, REVALIDATE_HEADER } from './route.js';
+export { ApiError, badRequest, unauthorized, forbidden, notFound, conflict, errorResponse, toApiError } from './errors.js';
+export { readJson, readQuery, DEFAULT_BODY_LIMIT } from './input.js';
+export { createOpenApiDocument, openApiRoute, describedBy, includeDocument, setJsonSchemaConverter } from './openapi.js';
+export { apiSecurity, securityHeaders, cors, originCheck, DEFAULT_SECURITY_HEADERS } from './security.js';
+export { rateLimit, memoryRateLimitStore, postgresRateLimitStore } from './rate-limit.js';