@softfault/blacketjs 0.1.0

package/dist/http.d.ts

@@ -0,0 +1,86 @@
+import type { BlacketJson, BlacketRecord, BlacketUploadFile, BlacketUploadResponse } from "./types";
+/**
+ * options for {@link BlacketClient} and the low-level http helper
+ */
+export type BlacketClientOptions = {
+    /**
+     * api origin (defaults to `https://blacket.org`)
+     */
+    baseUrl?: string;
+    /**
+     * raw cookie header value used for authenticated requests
+     */
+    cookie?: string;
+    /**
+     * extra headers added to every http and socket request
+     */
+    headers?: HeadersInit;
+    /**
+     * request timeout in milliseconds. defaults to 10000 (10s)
+     */
+    timeoutMs?: number;
+    /**
+     * number of times to retry 503 responses. defaults to 2
+     */
+    retry503?: number;
+    /**
+     * custom fetch implementation for tests or alternate runtimes
+     */
+    fetch?: typeof fetch;
+};
+/**
+ * thrown when blacket returns a non-json or otherwise unwrapped failed response
+ */
+export declare class BlacketHttpError extends Error {
+    /**
+     * http response status
+     */
+    readonly status: number;
+    /**
+     * parsed response body, or text when json parsing failed
+     */
+    readonly body: unknown;
+    constructor(status: number, body: unknown);
+}
+/**
+ * minimal http client used by the sdk categories
+ */
+export declare class BlacketHttp {
+    /**
+     * normalized base api url
+     */
+    readonly baseUrl: string;
+    private readonly cookie?;
+    private readonly headers?;
+    private readonly timeoutMs;
+    private readonly retry503;
+    private readonly fetchFn;
+    constructor(options?: BlacketClientOptions);
+    /**
+     * sends a get request and parses the response
+     */
+    get<T = unknown>(path: string): Promise<T>;
+    /**
+     * sends a json post request and parses the response
+     */
+    post<T = unknown>(path: string, body?: BlacketJson | BlacketRecord): Promise<T>;
+    /**
+     * runs blacket's signed upload flow and returns the public url
+     */
+    upload<T extends BlacketUploadResponse = BlacketUploadResponse>(path: string, file: BlacketUploadFile): Promise<T>;
+    /**
+     * builds a websocket url for the configured base url
+     */
+    socketUrl(path?: string): string;
+    /**
+     * builds websocket headers, including the configured cookie
+     */
+    socketHeaders(headers?: HeadersInit): Headers;
+    private request;
+    private requestHeaders;
+    private url;
+    private readBody;
+    private isRecord;
+    private wait;
+}
+//# sourceMappingURL=http.d.ts.map

package/dist/http.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../src/http.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAEpG;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IAC/B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;CACxB,CAAC;AAQF;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,KAAK;IACvC;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;gBAEX,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO;CAM5C;AAED;;GAEG;AACH,qBAAa,WAAW;IACpB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAc;IACvC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAe;gBAE3B,OAAO,GAAE,oBAAyB;IAS9C;;OAEG;IACG,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAIhD;;OAEG;IACG,IAAI,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,WAAW,GAAG,aAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;IAIzF;;OAEG;IACG,MAAM,CAAC,CAAC,SAAS,qBAAqB,GAAG,qBAAqB,EAChE,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,iBAAiB,GACxB,OAAO,CAAC,CAAC,CAAC;IAuCb;;OAEG;IACH,SAAS,CAAC,IAAI,SAAmB,GAAG,MAAM;IAM1C;;OAEG;IACH,aAAa,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO;YAc/B,OAAO;IAyCrB,OAAO,CAAC,cAAc;IAmBtB,OAAO,CAAC,GAAG;YAQG,QAAQ;IActB,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,IAAI;CAGf"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { BlacketClient } from "./client";
+export { BlacketHttp, BlacketHttpError, type BlacketClientOptions } from "./http";
+export { BlacketSocket, type BlacketSocketCallback, type BlacketSocketEmitEvents, type BlacketSocketEvents, type BlacketSocketMessage, type BlacketSocketOptions, } from "./socket";
+export type * from "./types";
+//# 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,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,KAAK,oBAAoB,EAAE,MAAM,QAAQ,CAAC;AAClF,OAAO,EACH,aAAa,EACb,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,GAC5B,MAAM,UAAU,CAAC;AAClB,mBAAmB,SAAS,CAAC"}