Compare commits

..

4 commits

Author SHA1 Message Date
5d6b4a4675
fix: set Content-Type headers for requests with payload (#7) 2023-11-09 13:15:49 +01:00
04e9c7ec84 fix: no request body on GET requests (#5) 2023-11-09 11:56:18 +01:00
87a5fd4cb9 fix: tailing slash for domain name (#4) 2023-11-09 11:56:18 +01:00
278868984d
fix: ESM exports (#2)
* wip: 2023-09-20T13:43:23+0200 (1695210203)

* wip: 2023-09-20T12:53:34+0200 (1695207214)

* wip: 2023-09-20T12:53:34+0200 (1695207214)

* wip: 2023-11-07T14:37:18+0100 (1699364238)
2023-11-09 10:51:01 +01:00
4 changed files with 88 additions and 11 deletions

52
.npmignore Normal file
View file

@ -0,0 +1,52 @@
/src
# Bootstrapping #
#################
/node_modules
/public/hot
/public/storage
/storage/*.key
/vendor
.env
.env.ini
.env.backup
.phpunit.result.cache
Homestead.json
Homestead.yaml
npm-debug.log
yarn-error.log
public/robots.txt
# OS generated files #
######################
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
Icon?
ehthumbs.db
Thumbs.db
.directory
# Tool specific files #
#######################
# vim
*~
*.swp
*.swo
# sublime text & textmate
*.sublime-*
*.stTheme.cache
*.tmlanguage.cache
*.tmPreferences.cache
# Eclipse
.settings/*
# JetBrains, aka PHPStorm, IntelliJ IDEA
.idea/*
# NetBeans
nbproject/*
# Visual Studio Code
.vscode
# Sass preprocessor
.sass-cache/

View file

@ -1,7 +1,16 @@
{ {
"name": "reflect-client", "name": "reflect-client",
"version": "1.0.0", "version": "1.1.2",
"main": "build/Reflect.js", "main": "build/Reflect.js",
"type": "module",
"exports": {
".": {
"import": {
"types": "./src/Reflect.ts",
"default": "./build/Reflect.js"
}
}
},
"devDependencies": { "devDependencies": {
"typescript": "^5.2.2" "typescript": "^5.2.2"
} }

View file

@ -1,4 +1,7 @@
import { Method } from "./Method"; import { Method } from "./Method.js";
// Export Method as importable directly from the Reflect.js ESM
export { Method };
// Connect to a Reflect API instance over HTTP // Connect to a Reflect API instance over HTTP
export default class Client { export default class Client {
@ -6,7 +9,8 @@ export default class Client {
private headers: object = {}; private headers: object = {};
constructor(url: string, key: string|null = null) { constructor(url: string, key: string|null = null) {
this.url = url; // Append tailing slash if omitted from URL string
this.url = url.substring(url.length - 1) === "/" ? url : url + "/";
// Use API key with requests if defined // Use API key with requests if defined
if (key) { if (key) {
@ -14,9 +18,22 @@ export default class Client {
} }
} }
// Set request header
private setHeader(name, value): void {
return this.headers[name] = value;
}
// Set API key to use for all requests // Set API key to use for all requests
private setApiKey(key: string): void { private setApiKey(key: string): void {
this.headers["Authentication"] = `Bearer ${key}`; return this.setHeader("Authorization", `Bearer ${key}`);
}
// Get fully qualified URL to endpoint
private getEndpoint(endpoint: string): string {
// Remove leading slash if provided for pathname. It's already set on the domain name
endpoint = endpoint.substring(0, 1) !== "/" ? endpoint : endpoint.substring(1, endpoint.length);
return this.url + endpoint;
} }
// Call a Reflect API endpoint with method and optional payload // Call a Reflect API endpoint with method and optional payload
@ -26,12 +43,13 @@ export default class Client {
headers: this.headers headers: this.headers
} }
// JSON stringify and append body to request if provided // JSON stringify and append body to request if provided and is not a GET request
if (payload) { if (payload && method !== Method.GET) {
this.setHeader("Content-Type", "application/json");
options["body"] = JSON.stringify(payload); options["body"] = JSON.stringify(payload);
} }
// Fetch and return Response object // Fetch and return Response object
return await fetch(endpoint, options); return await fetch(this.getEndpoint(endpoint), options);
} }
} }

View file

@ -2,9 +2,7 @@
"compilerOptions": { "compilerOptions": {
"emitDecoratorMetadata": true, "emitDecoratorMetadata": true,
"experimentalDecorators": true, "experimentalDecorators": true,
"module": "amd", "module": "NodeNext",
"target": "ES6", "outDir": "./build"
"rootDir": "./src",
"outFile": "./build/Reflect.js"
} }
} }