@gravlabs/appwrite-hono-adapter-bun - npm Package Compare versions

Comparing version 0.2.0 to 0.3.0

lib/main.js

@@ -35,3 +35,3 @@ // src/main.ts
           context.req,
-          // TODO: see if way to cache abort controller
+          /** @todo see if way to cache abort controller */
           new AbortController()
@@ -38,0 +38,0 @@ ),

lib/types.d.ts

 import type { Hono } from 'hono';
+import type { IncomingHttpHeaders, OutgoingHttpHeaders } from 'node:http';
+export type NormalizeString<Key extends string, O, Matcher extends string> = Key extends keyof O ? Key : Key extends `${Matcher}${infer S}` ? `${Matcher}${S}` : never;
+/**
+ * HTTP request methods.
+ *
+ * HTTP defines a set of request methods to indicate the desired action to be
+ * performed for a given resource. Although they can also be nouns, these
+ * request methods are sometimes referred as HTTP verbs. Each of them implements
+ * a different semantic, but some common features are shared by a group of them:
+ * e.g. a request method can be safe, idempotent, or cacheable.
+ *
+ * @public
+ */
+export type HTTPMethod = 
+/**
+ * The `CONNECT` method establishes a tunnel to the server identified by the
+ * target resource.
+ */
+'CONNECT'
+/**
+ * The `DELETE` method deletes the specified resource.
+ */
+ | 'DELETE'
+/**
+ * The `GET` method requests a representation of the specified resource.
+ * Requests using GET should only retrieve data.
+ */
+ | 'GET'
+/**
+ * The `HEAD` method asks for a response identical to that of a GET request,
+ * but without the response body.
+ */
+ | 'HEAD'
+/**
+ * The `OPTIONS` method is used to describe the communication options for the
+ * target resource.
+ */
+ | 'OPTIONS'
+/**
+ * The PATCH method is used to apply partial modifications to a resource.
+ */
+ | 'PATCH'
+/**
+ * The `POST` method is used to submit an entity to the specified resource,
+ * often causing a change in state or side effects on the server.
+ */
+ | 'POST'
+/**
+ * The `PUT` method replaces all current representations of the target
+ * resource with the request payload.
+ */
+ | 'PUT'
+/**
+ * The `TRACE` method performs a message loop-back test along the path to the
+ * target resource.
+ */
+ | 'TRACE';
+export type InfoStatusCode = 100 | 101 | 102 | 103;
+export type SuccessStatusCode = 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 226;
+export type DeprecatedStatusCode = 305 | 306;
+export type RedirectStatusCode = 300 | 301 | 302 | 303 | 304 | DeprecatedStatusCode | 307 | 308;
+export type ClientErrorStatusCode = 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 421 | 422 | 423 | 424 | 425 | 426 | 428 | 429 | 431 | 451;
+export type ServerErrorStatusCode = 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 510 | 511;
+/**
+ * `UnofficialStatusCode` can be used to specify an unofficial status code.
+ * @example
+ *
+ * ```ts
+ * app.get('/unknown', (c) => {
+ *   return c.text("Unknown Error", 520 as UnofficialStatusCode)
+ * })
+ * ```
+ */
+export type UnofficialStatusCode = -1;
+/**
+ * If you want to use an unofficial status, use `UnofficialStatusCode`.
+ */
+export type StatusCode = InfoStatusCode | SuccessStatusCode | RedirectStatusCode | ClientErrorStatusCode | ServerErrorStatusCode | UnofficialStatusCode;
+export type KnownAppwriteHeader = 'x-appwrite-trigger' | 'x-appwrite-event' | 'x-appwrite-user-id' | 'x-appwrite-user-jwt' | 'x-appwrite-country-code' | 'x-appwrite-continent-code' | 'x-appwrite-continent-eu';
+export type KnownOpenRuntimeHeader = 'x-open-runtimes-timeout' | 'x-open-runtimes-secret' | 'x-forwarded-proto' | 'x-open-runtimes-log-id' | 'x-open-runtimes-logging';
+export type KnownHeaders = KnownAppwriteHeader | KnownOpenRuntimeHeader;
+export type PatternHeaders = `x-open-runtimes-${string}` | `x-appwrite-${string}`;
+export type KnownHeaderMap = {
+    [K in KnownHeaders]: string;
+};
+export type HeaderMap = KnownHeaderMap & {
+    [key: PatternHeaders]: string;
+};
+export type IncomingHeaders = Partial<IncomingHttpHeaders & HeaderMap> & {
+    [key: string]: string;
+};
+export type OutgoingHeaders = Partial<OutgoingHttpHeaders & HeaderMap> & {
+    [key: string]: string;
+};
 export type JSONStub = Record<string | number | symbol, unknown>;
 export type FetchFunction = (request: Request, env: Context) => ReturnType<Hono['fetch']>;
 export interface ReqContext {
-    get body(): string | Buffer | JSONStub;
     get bodyRaw(): string;
-    get bodyText(): string;
-    get bodyJson(): JSONStub;
-    get bodyBinary(): Buffer;
-    headers: Record<string, string>;
-    method: Request['method'];
-    host: string;
-    scheme: string;
+    get body(): string | JSONStub;
+    headers: IncomingHeaders;
+    method: HTTPMethod;
+    url: string;
     query: Record<string, string>;
     queryString: string;
+    host: string;
     port: number;
-    url: string;
+    scheme: 'http' | 'https';
     path: string;
 }
-export type LogContext = (message: unknown | JSONStub) => void;
+export type LogContext = (message: string | JSONStub | unknown) => void;
 export interface ResContext {
-    send: (body: string | ArrayBuffer | ReadableStream, statusCode?: Response['status'], headers?: Record<string, string>) => void;
-    json: (body: JSONStub, statusCode?: Response['status'], headers?: Record<string, string>) => void;
+    send: (body: string | ArrayBuffer | ReadableStream, statusCode?: StatusCode, headers?: OutgoingHeaders) => void;
+    json: (body: JSONStub, statusCode?: StatusCode, headers?: OutgoingHeaders) => void;
     empty: () => void;
-    redirect: (url: string, statusCode?: Response['status'], headers?: Record<string, string>) => void;
+    redirect: (url: string, statusCode?: StatusCode, headers?: OutgoingHeaders) => void;
 }
@@ -33,8 +124,5 @@ export interface Context {
 }
-export interface AppwriteBindings extends Record<string, unknown> {
-    req: ReqContext;
-    res: ResContext;
-    log: LogContext;
-    error: LogContext;
-}
+export type AppwriteBindings = {
+    [K in keyof Context]: Context[K];
+};
 //# sourceMappingURL=types.d.ts.map

package.json

 {
   "name": "@gravlabs/appwrite-hono-adapter-bun",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "type": "module",
@@ -5,0 +5,0 @@ "main": "lib/main.js",

No alert changes

Improved metrics

Total package byte prevSize

28869

increased by14.37%

Lines of code

331

increased by36.21%

No dependency changes