@auldrant/api 0.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Adam Hughes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,19 @@
+# @auldrant/api
+
+@auldrant/api is a client-side library intended to simplify working with Web APIs so you can focus on your core application logic. It also provides some content useful for server-side applications as well. We recommend using [Bun](https://bun.sh) to work with @auldrant/api. To install
+
+```bash
+bun install
+```
+
+## Static Content
+
+@auldrant/api is designed to provide simple, reusable code for common work with APIs. All static content can be found in [static.ts][static]. This includes common content like HTTP methods and status codes, as well as many types for the most common HTTP headers including MIME types and encodings, and some helper typings for working with requests and responses.
+
+## Methods
+
+@auldrant/api's main feature is [apiCall], which aims to provide a simpler interface for working with [fetch] that handles some of the technical operations automatically, behind the scenes. For example, it will automatically perform supported compression on content upon request and set the appropriate `Content-Encoding` header.
+
+[static]: ./src/static.ts
+[apiCall]: ./src/apiCall.ts
+[fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API

package/dist/index.d.ts

@@ -0,0 +1,110 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export declare const enum HttpStatus {
+	OK = 200,
+	CREATED = 201,
+	ACCEPTED = 202,
+	NO_CONTENT = 204,
+	PARTIAL_CONTENT = 206,
+	MOVED_PERMANENTLY = 301,
+	FOUND = 302,
+	SEE_OTHER = 303,
+	NOT_MODIFIED = 304,
+	TEMPORARY_REDIRECT = 307,
+	PERMANENT_REDIRECT = 308,
+	BAD_REQUEST = 400,
+	UNAUTHORIZED = 401,
+	PAYMENT_REQUIRED = 402,
+	FORBIDDEN = 403,
+	NOT_FOUND = 404,
+	METHOD_NOT_ALLOWED = 405,
+	NOT_ACCEPTABLE = 406,
+	PROXY_AUTHENTICATION_REQUIRED = 407,
+	REQUEST_TIMEOUT = 408,
+	CONFLICT = 409,
+	GONE = 410,
+	LENGTH_REQUIRED = 411,
+	PRECONDITION_FAILED = 412,
+	PAYLOAD_TOO_LARGE = 413,
+	URI_TOO_LONG = 414,
+	UNSUPPORTED_MEDIA_TYPE = 415,
+	RANGE_NOT_SATISFIABLE = 416,
+	EXPECTATION_FAILED = 417,
+	IM_A_TEAPOT = 418,
+	MISDIRECTED_REQUEST = 421,
+	UNPROCESSABLE_ENTITY = 422,
+	LOCKED = 423,
+	FAILED_DEPENDENCY = 424,
+	TOO_EARLY = 425,
+	UPGRADE_REQUIRED = 426,
+	PRECONDITION_REQUIRED = 428,
+	TOO_MANY_REQUESTS = 429,
+	REQUEST_HEADER_FIELDS_TOO_LARGE = 431,
+	UNAVAILABLE_FOR_LEGAL_REASONS = 451,
+	INTERNAL_SERVER_ERROR = 500,
+	NOT_IMPLEMENTED = 501,
+	BAD_GATEWAY = 502,
+	SERVICE_UNAVAILABLE = 503,
+	GATEWAY_TIMEOUT = 504,
+	HTTP_VERSION_NOT_SUPPORTED = 505,
+	VARIANT_ALSO_NEGOTIATES = 506,
+	INSUFFICIENT_STORAGE = 507,
+	LOOP_DETECTED = 508,
+	NOT_EXTENDED = 510,
+	NETWORK_AUTHENTICATION_REQUIRED = 511
+}
+declare const enum MimeType$1 {
+	HTML = "text/html",
+	PLAIN = "text/plain",
+	CSV = "text/csv",
+	CSS = "text/css",
+	JAVASCRIPT = "text/javascript",
+	JSON = "application/json",
+	XML = "application/xml",
+	PDF = "application/pdf",
+	ZIP = "application/zip",
+	GZIP = "application/gzip",
+	OCTET_STREAM = "application/octet-stream",
+	JPEG = "image/jpeg",
+	PNG = "image/png",
+	GIF = "image/gif",
+	SVG = "image/svg+xml",
+	WEBP = "image/webp",
+	MP4 = "video/mp4",
+	WEBM = "video/webm",
+	MP3 = "audio/mpeg",
+	OGG = "audio/ogg",
+	WAV = "audio/wav",
+	ICO = "image/x-icon",
+	TAR = "application/x-tar"
+}
+export declare const enum HttpMethod {
+	GET = "GET",
+	POST = "POST",
+	PUT = "PUT",
+	DELETE = "DELETE",
+	PATCH = "PATCH",
+	OPTIONS = "OPTIONS",
+	HEAD = "HEAD"
+}
+export declare const enum CompressionMethod {
+	GZIP = "gzip",
+	DEFLATE = "deflate"
+}
+export interface IRequestArgs {
+	body?: BodyInit;
+	contentType?: MimeType$1;
+	accept?: MimeType$1;
+	compression?: CompressionMethod;
+}
+export declare const apiCall: <T>(url: string | URL, method: HttpMethod, requestArgs: IRequestArgs, controller: AbortController) => Promise<{
+	data: T | null;
+	status: HttpStatus;
+}>;
+export declare function logRequest(req: Request): void;
+
+export {
+	MimeType$1 as MimeType,
+};
+
+export {};

package/dist/index.js

@@ -0,0 +1 @@
+var D;((E)=>{E[E.OK=200]="OK";E[E.CREATED=201]="CREATED";E[E.ACCEPTED=202]="ACCEPTED";E[E.NO_CONTENT=204]="NO_CONTENT";E[E.PARTIAL_CONTENT=206]="PARTIAL_CONTENT";E[E.MOVED_PERMANENTLY=301]="MOVED_PERMANENTLY";E[E.FOUND=302]="FOUND";E[E.SEE_OTHER=303]="SEE_OTHER";E[E.NOT_MODIFIED=304]="NOT_MODIFIED";E[E.TEMPORARY_REDIRECT=307]="TEMPORARY_REDIRECT";E[E.PERMANENT_REDIRECT=308]="PERMANENT_REDIRECT";E[E.BAD_REQUEST=400]="BAD_REQUEST";E[E.UNAUTHORIZED=401]="UNAUTHORIZED";E[E.PAYMENT_REQUIRED=402]="PAYMENT_REQUIRED";E[E.FORBIDDEN=403]="FORBIDDEN";E[E.NOT_FOUND=404]="NOT_FOUND";E[E.METHOD_NOT_ALLOWED=405]="METHOD_NOT_ALLOWED";E[E.NOT_ACCEPTABLE=406]="NOT_ACCEPTABLE";E[E.PROXY_AUTHENTICATION_REQUIRED=407]="PROXY_AUTHENTICATION_REQUIRED";E[E.REQUEST_TIMEOUT=408]="REQUEST_TIMEOUT";E[E.CONFLICT=409]="CONFLICT";E[E.GONE=410]="GONE";E[E.LENGTH_REQUIRED=411]="LENGTH_REQUIRED";E[E.PRECONDITION_FAILED=412]="PRECONDITION_FAILED";E[E.PAYLOAD_TOO_LARGE=413]="PAYLOAD_TOO_LARGE";E[E.URI_TOO_LONG=414]="URI_TOO_LONG";E[E.UNSUPPORTED_MEDIA_TYPE=415]="UNSUPPORTED_MEDIA_TYPE";E[E.RANGE_NOT_SATISFIABLE=416]="RANGE_NOT_SATISFIABLE";E[E.EXPECTATION_FAILED=417]="EXPECTATION_FAILED";E[E.IM_A_TEAPOT=418]="IM_A_TEAPOT";E[E.MISDIRECTED_REQUEST=421]="MISDIRECTED_REQUEST";E[E.UNPROCESSABLE_ENTITY=422]="UNPROCESSABLE_ENTITY";E[E.LOCKED=423]="LOCKED";E[E.FAILED_DEPENDENCY=424]="FAILED_DEPENDENCY";E[E.TOO_EARLY=425]="TOO_EARLY";E[E.UPGRADE_REQUIRED=426]="UPGRADE_REQUIRED";E[E.PRECONDITION_REQUIRED=428]="PRECONDITION_REQUIRED";E[E.TOO_MANY_REQUESTS=429]="TOO_MANY_REQUESTS";E[E.REQUEST_HEADER_FIELDS_TOO_LARGE=431]="REQUEST_HEADER_FIELDS_TOO_LARGE";E[E.UNAVAILABLE_FOR_LEGAL_REASONS=451]="UNAVAILABLE_FOR_LEGAL_REASONS";E[E.INTERNAL_SERVER_ERROR=500]="INTERNAL_SERVER_ERROR";E[E.NOT_IMPLEMENTED=501]="NOT_IMPLEMENTED";E[E.BAD_GATEWAY=502]="BAD_GATEWAY";E[E.SERVICE_UNAVAILABLE=503]="SERVICE_UNAVAILABLE";E[E.GATEWAY_TIMEOUT=504]="GATEWAY_TIMEOUT";E[E.HTTP_VERSION_NOT_SUPPORTED=505]="HTTP_VERSION_NOT_SUPPORTED";E[E.VARIANT_ALSO_NEGOTIATES=506]="VARIANT_ALSO_NEGOTIATES";E[E.INSUFFICIENT_STORAGE=507]="INSUFFICIENT_STORAGE";E[E.LOOP_DETECTED=508]="LOOP_DETECTED";E[E.NOT_EXTENDED=510]="NOT_EXTENDED";E[E.NETWORK_AUTHENTICATION_REQUIRED=511]="NETWORK_AUTHENTICATION_REQUIRED"})(D||={});var P;((O)=>{O.HTML="text/html";O.PLAIN="text/plain";O.CSV="text/csv";O.CSS="text/css";O.JAVASCRIPT="text/javascript";O.JSON="application/json";O.XML="application/xml";O.PDF="application/pdf";O.ZIP="application/zip";O.GZIP="application/gzip";O.OCTET_STREAM="application/octet-stream";O.JPEG="image/jpeg";O.PNG="image/png";O.GIF="image/gif";O.SVG="image/svg+xml";O.WEBP="image/webp";O.MP4="video/mp4";O.WEBM="video/webm";O.MP3="audio/mpeg";O.OGG="audio/ogg";O.WAV="audio/wav";O.ICO="image/x-icon";O.TAR="application/x-tar"})(P||={});var C;((R)=>{R.GET="GET";R.POST="POST";R.PUT="PUT";R.DELETE="DELETE";R.PATCH="PATCH";R.OPTIONS="OPTIONS";R.HEAD="HEAD"})(C||={});var L;((_)=>{_.GZIP="gzip";_.DEFLATE="deflate"})(L||={});function Y(A,I){switch(I){case"gzip":case"deflate":return new Blob([JSON.stringify(A)]).stream().pipeThrough(new CompressionStream(I));default:return A}}var Q=async(A,I,_,G)=>{try{let{body:N,contentType:g,accept:U,compression:R}=_,F=N?Y(N,R):void 0,{signal:x}=G,T=await fetch(A,{signal:x,method:I,body:F,headers:new Headers({"Content-Type":g,Accept:U,"Content-Encoding":R})});if(!T.ok)return console.error(`Encountered error ${T.status}`),{data:null,status:T.status};switch(U){case"application/json":return await T.json();case"text/plain":case"text/html":case"text/csv":case"application/xml":case"text/css":case"text/javascript":return{data:await T.text(),status:T.status};default:return{data:await T.blob(),status:T.status}}}catch(N){return console.error(N.message),{data:null,status:500}}},V=Q;function B(A){console.log(`Path: ${new URL(A.url).pathname}`),console.log(`Method: ${A.method}`),console.log("Headers:"),A.headers.forEach((I,_)=>console.log(`${_}=${I}`))}export{B as logRequest,V as apiCall,P as MimeType,D as HttpStatus,C as HttpMethod,L as CompressionMethod};

package/package.json

@@ -0,0 +1,41 @@
+{
+	"name": "@auldrant/api",
+	"version": "0.0.4",
+	"author": "Colonel Jade <colonel.jade@proton.me> (https://github.com/coloneljade/)",
+	"repository": "github:coloneljade/auldrant-api",
+	"homepage": "https://github.com/coloneljade/auldrant-api#readme",
+	"license": "MIT",
+	"type": "module",
+	"module": "dist/index.js",
+	"devDependencies": {
+		"@types/bun": "^1.1.14",
+		"bun-plugin-dts": "^0.3.0",
+		"fs": "^0.0.1-security",
+		"oxc-transform": "^0.43.0",
+		"path": "^0.12.7",
+		"typescript": "^5.7.2",
+		"yargs": "^17.7.2"
+	},
+	"exports": {
+		".": "./dist/index.js"
+	},
+	"types": "./dist/index.d.ts",
+	"bugs": {
+		"url": "https://github.com/coloneljade/auldrant-api/issues",
+		"email": "colonel.jade@proton.me"
+	},
+	"description": "Simple library for working with APIs",
+	"files": [
+		"dist/**/*.js",
+		"dist/**/*.d.ts",
+		"LICENSE"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"build": "bun clean && bun ./build.ts",
+		"clean": "bun ./clean.ts --dir dist",
+		"publish": "bun test && bun publish --frozen-lockfile"
+	}
+}