api.global/sdk
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update documentation

Browse Source
This commit is contained in:
Philipp Kunz 2024-04-14 18:56:50 +02:00
parent cb7331e0b8
commit 7e4f16a4df
5 changed files with 207 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
npmextra.json
View File

@ -2,17 +2,37 @@
"gitzone": {
"projectType": "npm",
"module": {
"githost": "gitlab.com",
"gitscope": "apiglobal",
"githost": "code.foss.global",
"gitscope": "api.global",
"gitrepo": "sdk",
"description": "an sdk package for api.global",
"npmPackagename": "@apiglobal/sdk",
"description": "A software development kit for interacting with api.global services.",
"npmPackagename": "@api.global/sdk",
"license": "MIT",
"projectDomain": "api.global"
"projectDomain": "api.global",
"keywords": [
"SDK",
"api.global",
"TypeScript",
"authentication",
"HTTP requests",
"environment variables",
"typed requests",
"open source",
"code contributions",
"npm package",
"API development",
"handlers",
"modular design",
"code quality",
"software development kit"
]
}
},
"npmci": {
"npmGlobalTools": [],
"npmAccessLevel": "public"
},
"tsdoc": {
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
}
}

23
package.json
View File

@ -1,8 +1,8 @@
{
"name": "@apiglobal/sdk",
"name": "@api.global/sdk",
"version": "2.0.1",
"private": false,
"description": "an sdk package for api.global",
"description": "A software development kit for interacting with api.global services.",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"author": "Lossless GmbH",
@ -39,5 +39,22 @@
"browserslist": [
"last 1 chrome versions"
],
"type": "module"
"type": "module",
"keywords": [
"SDK",
"api.global",
"TypeScript",
"authentication",
"HTTP requests",
"environment variables",
"typed requests",
"open source",
"code contributions",
"npm package",
"API development",
"handlers",
"modular design",
"code quality",
"software development kit"
]
}

1
readme.hints.md Normal file
View File

@ -0,0 +1 @@

178
readme.md
View File

@ -1,37 +1,163 @@
# @apiglobal/sdk
# @api.global/sdk
an sdk package for api.global
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@apiglobal/sdk)
* [gitlab.com (source)](https://gitlab.com/apiglobal/sdk)
* [github.com (source mirror)](https://github.com/apiglobal/sdk)
* [docs (typedoc)](https://apiglobal.gitlab.io/sdk/)
## Install
## Status for master
To install `@api.global/sdk`, you need to have Node.js installed on your machine. This package is available through the npm registry. Installation can be done using the npm or yarn command line tools.
Status Category | Status Badge
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/apiglobal/sdk/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/apiglobal/sdk/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@apiglobal/sdk)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/apiglobal/sdk)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@apiglobal/sdk)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@apiglobal/sdk)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@apiglobal/sdk)](https://lossless.cloud)
```bash
npm install @api.global/sdk --save
```
or
```bash
yarn add @api.global/sdk
```
## Usage
Use TypeScript for best in class intellisense
Using `@api.global/sdk` requires an understanding of TypeScript and asynchronous programming concepts in Node.js. Below, we will outline a series of use cases to demonstrate how to utilize the SDK effectively in your projects.
## Contribution
### Setting Up Your Project
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
Before proceeding with the usage examples, ensure your TypeScript configuration (`tsconfig.json`) is correctly set up for an ES Module syntax project.
For further information read the linked docs at the top of this readme.
### Importing the SDK
## Legal
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
Once installed, you can import the entire SDK or specific parts of it into your project files:
```typescript
import * as ApiGlobalSdk from '@api.global/sdk';
```
Or import specific classes if you're only interested in a subset of functionalities:
```typescript
import { AAgHandler, AgEnvironment, AuthInfo } from '@api.global/sdk';
```
### Creating an Environment Handler
`AgEnvironment` is an abstract class that manages the provision of environment variables. A concrete implementation could look like this:
```typescript
import { AgEnvironment } from '@api.global/sdk';
class MyEnvironment extends AgEnvironment {
private envVariables: Map<string, string> = new Map([
['API_KEY', 'your-api-key-here'],
// Add other environment variables
]);
public async getEnvVar(envVarName: string): Promise<string> {
return this.envVariables.get(envVarName) || '';
}
}
const myEnvironment = new MyEnvironment();
```
### Implementing an Authorization Handler
The SDK requires implementing an authorization handler by extending the `AuthInfo` class. This class manages authentication and potential security flags for incoming requests.
```typescript
import { AuthInfo } from '@api.global/sdk';
class MyAuthInfo extends AuthInfo<any> {
public authenticated: boolean = false;
public potentiallyMalicious: boolean = false;
public claim: any;
constructor(claim: any) {
super();
this.claim = claim;
// Implement logic to set 'authenticated' and 'potentiallyMalicious'
}
}
```
### Creating an API Handler
Create an API handler by extending `AAgHandler`. This handler will manage API requests and connect them to your business logic.
```typescript
import { AAgHandler, IRequirementResult } from '@api.global/sdk';
import { TypedRouter } from '@apiglobal/typedrequest';
class MyApiHandler extends AAgHandler<any> {
public slug: string = 'myApi';
public typedrouter: TypedRouter = new TypedRouter();
public async checkRequirements(): Promise<IRequirementResult> {
// Implement checks for your requirements here
return { allOk: true, reason: '' };
}
constructor(agEnvironment: AgEnvironment) {
super(agEnvironment);
// Additional constructor logic
}
public async start(): Promise<void> {
// Implement starting logic here
}
public async stop(): Promise<void> {
// Implement stopping logic here
}
}
// Usage
const myApiHandler = new MyApiHandler(myEnvironment);
```
### Starting Your API Handler
Finally, start your API handler as part of your application's boot-up sequence.
```typescript
async function startApplication() {
try {
await myApiHandler.start();
console.log('API handler started successfully.');
} catch (error) {
console.error('Failed to start API handler:', error);
}
}
startApplication();
```
### Advanced Use Cases
- **Custom AuthInfo Implementations**: Depending on your application's authentication mechanism (e.g., OAuth2, JWT), you may need to create more sophisticated `AuthInfo` implementations.
- **Feature Flags and Environment Variables**: Use `AgEnvironment` to manage feature flags or other configuration that might change between different environments.
- **TypedRequest Integrations**: Leverage the `TypedRouter` from `@apiglobal/typedrequest` to create strongly typed endpoints and request handlers within your `AAgHandler` implementation.
### Conclusion
The `@api.global/sdk` offers powerful abstractions to create well-structured, environment-aware, and secure API handlers for Node.js applications. By extending its base classes and implementing the required methods, you can quickly build scalable and maintainable backend services.
Remember, the key to effectively using `@api.global/sdk` is understanding its core concepts and how they fit into your application's architecture. With this knowledge, you can extend the SDK to meet your specific needs, ensuring a robust and flexible API layer.
## License and Legal Information
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
### Trademarks
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
### Company Information
Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

12
tsconfig.json
View File

@ -3,8 +3,12 @@
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "ES2022",
"moduleResolution": "nodenext",
"esModuleInterop": true
}
"module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true
},
"exclude": [
"dist_*/**/*.d.ts"
]
}