mirror of
https://github.com/kc4x4sar/d4h-typescript.git
synced 2026-07-12 17:21:05 -07:00
Added test project.
This commit is contained in:
Colin Williams
@@ -0,0 +1,6 @@
|
||||
import D4H from './src/d4h.js';
|
||||
export default D4H;
|
||||
|
||||
export * from './src/d4h.js'
|
||||
export * from './src/group.js'
|
||||
export * from './src/member.js'
|
||||
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"name": "d4h-typescript",
|
||||
"version": "1.0.0",
|
||||
"main": "./built/index.js",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"build": "npx tsc"
|
||||
},
|
||||
"devDependencies": {
|
||||
"typescript": "^4.8.4"
|
||||
},
|
||||
"dependencies": {
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,96 @@
|
||||
import HttpUtils from "./httpUtils";
|
||||
import type { Group } from "./group";
|
||||
import type { Member } from "./member";
|
||||
|
||||
const D4H_FETCH_LIMIT = 250;
|
||||
const D4H_BASE_URL = "https://api.d4h.org/v2";
|
||||
|
||||
export interface GetMemberOptions {
|
||||
includeDetails?: boolean;
|
||||
}
|
||||
|
||||
export interface GetMembersOptions {
|
||||
groupId?: number;
|
||||
includeCustomFields?: boolean;
|
||||
includeDetails?: boolean;
|
||||
}
|
||||
|
||||
export interface GetGroupsOptions {
|
||||
memberId?: number;
|
||||
title?: string;
|
||||
}
|
||||
|
||||
export default class D4H {
|
||||
private readonly _httpUtils: HttpUtils;
|
||||
|
||||
constructor(token: string) {
|
||||
this._httpUtils = new HttpUtils(token, D4H_FETCH_LIMIT);
|
||||
}
|
||||
|
||||
/********************************************/
|
||||
/**************** MEMBERS *******************/
|
||||
/********************************************/
|
||||
|
||||
async getMember(id: number, options?: GetMemberOptions): Promise<Member> {
|
||||
let url = new URL(`${D4H_BASE_URL}/team/members/${id}`)
|
||||
|
||||
if (options !== undefined) {
|
||||
let optionsList = url.searchParams;
|
||||
|
||||
if (options.includeDetails !== undefined) {
|
||||
optionsList.append("include_details", "true");
|
||||
}
|
||||
}
|
||||
|
||||
return await this._httpUtils.get<Member>(url);
|
||||
}
|
||||
|
||||
async getMembers(options?: GetMembersOptions): Promise<Member[]> {
|
||||
let url = new URL(`${D4H_BASE_URL}/team/members`)
|
||||
|
||||
if (options !== undefined) {
|
||||
let optionsList = url.searchParams;
|
||||
|
||||
if (options.groupId !== undefined) {
|
||||
optionsList.append("group_id", "true");
|
||||
}
|
||||
|
||||
if (options.includeDetails !== undefined) {
|
||||
optionsList.append("include_details", "true");
|
||||
}
|
||||
|
||||
if (options.includeCustomFields !== undefined) {
|
||||
optionsList.append("include_custom_fields", "true");
|
||||
}
|
||||
}
|
||||
|
||||
return await this._httpUtils.getMany(url);
|
||||
}
|
||||
|
||||
/********************************************/
|
||||
/***************** GROUPS *******************/
|
||||
/********************************************/
|
||||
|
||||
async getGroup(id: number): Promise<Group> {
|
||||
let url = new URL(`${D4H_BASE_URL}/team/groups/${id}`)
|
||||
return await this._httpUtils.get<Group>(url);
|
||||
}
|
||||
|
||||
async getGroups(options?: GetGroupsOptions): Promise<Group[]> {
|
||||
let url = new URL(`${D4H_BASE_URL}/team/groups`)
|
||||
|
||||
if (options !== undefined) {
|
||||
let optionsList = url.searchParams;
|
||||
|
||||
if (options.memberId !== undefined) {
|
||||
optionsList.append("member_id", options.memberId.toString());
|
||||
}
|
||||
|
||||
if (options.title !== undefined) {
|
||||
optionsList.append("title", options.title);
|
||||
}
|
||||
}
|
||||
|
||||
return await this._httpUtils.getMany(url);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,5 @@
|
||||
export interface Group {
|
||||
bundle: string;
|
||||
id: number;
|
||||
title: string;
|
||||
}
|
||||
@@ -0,0 +1,63 @@
|
||||
interface D4HResponse<DataType> {
|
||||
statusCode: number;
|
||||
data: DataType;
|
||||
error: string;
|
||||
}
|
||||
|
||||
interface D4HError {
|
||||
statusCode: number;
|
||||
error: string;
|
||||
}
|
||||
|
||||
export default class HttpUtils {
|
||||
private readonly _fetchLimit: number;
|
||||
private readonly _token: string;
|
||||
|
||||
constructor(token: string, fetchLimit: number) {
|
||||
if (!token) {
|
||||
throw new Error("Token cannot be empty");
|
||||
}
|
||||
|
||||
this._fetchLimit = fetchLimit;
|
||||
this._token = token;
|
||||
}
|
||||
|
||||
async get<DataType>(url: URL): Promise<DataType> {
|
||||
let method = "GET";
|
||||
let headers = {
|
||||
"Authorization": `Bearer ${this._token}`,
|
||||
};
|
||||
|
||||
console.log(url);
|
||||
|
||||
let rawResponse = await fetch(url.toString(), { method, headers });
|
||||
let response = await rawResponse.json() as D4HResponse<DataType>;
|
||||
|
||||
if (response.statusCode !== 200) {
|
||||
throw response as D4HError;
|
||||
}
|
||||
|
||||
return response.data as DataType;
|
||||
}
|
||||
|
||||
async getMany<DataType>(url: URL): Promise<DataType[]> {
|
||||
let results: DataType[] = [];
|
||||
|
||||
let offset = 0;
|
||||
while (true) {
|
||||
let urlWithOffset = new URL(url);
|
||||
urlWithOffset.searchParams.append('offset', offset.toString());
|
||||
urlWithOffset.searchParams.append('limit', this._fetchLimit.toString());
|
||||
|
||||
let newResults = await this.get<DataType[]>(urlWithOffset);
|
||||
results = results.concat(newResults);
|
||||
offset += this._fetchLimit;
|
||||
|
||||
if (newResults.length < this._fetchLimit) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return results;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,49 @@
|
||||
export enum CustomFieldType {
|
||||
Number = "number",
|
||||
Text = "text",
|
||||
Date = "date",
|
||||
}
|
||||
|
||||
export interface CustomField {
|
||||
id: number;
|
||||
type: CustomFieldType;
|
||||
label: string;
|
||||
value_string: string | undefined;
|
||||
value: string | undefined;
|
||||
}
|
||||
|
||||
export interface EmergencyContact {
|
||||
name: string;
|
||||
relation: string;
|
||||
phone: string;
|
||||
alt_phone: string;
|
||||
}
|
||||
|
||||
export interface MemberStatus {
|
||||
id: number;
|
||||
type: string;
|
||||
value: string;
|
||||
label: MemberStatusLabel | undefined;
|
||||
}
|
||||
|
||||
export interface MemberStatusLabel {
|
||||
id: number;
|
||||
value: string;
|
||||
}
|
||||
|
||||
export interface Member {
|
||||
address: string;
|
||||
custom_fields: CustomField[];
|
||||
email: string;
|
||||
emergency_contacts: EmergencyContact;
|
||||
group_ids: number[];
|
||||
homephone: string;
|
||||
id: number;
|
||||
mobilephone: string;
|
||||
name: string;
|
||||
notes: string;
|
||||
position: string;
|
||||
ref: string;
|
||||
status: MemberStatus;
|
||||
workphone: string;
|
||||
}
|
||||
@@ -0,0 +1,103 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
/* Visit https://aka.ms/tsconfig to read more about this file */
|
||||
|
||||
/* Projects */
|
||||
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
|
||||
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
|
||||
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
|
||||
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
|
||||
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
|
||||
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
|
||||
|
||||
/* Language and Environment */
|
||||
"target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
|
||||
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
|
||||
// "jsx": "preserve", /* Specify what JSX code is generated. */
|
||||
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
|
||||
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
|
||||
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
|
||||
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
|
||||
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
|
||||
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
|
||||
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
|
||||
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
|
||||
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
|
||||
|
||||
/* Modules */
|
||||
"module": "commonjs", /* Specify what module code is generated. */
|
||||
// "rootDir": "./", /* Specify the root folder within your source files. */
|
||||
// "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
|
||||
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
|
||||
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
|
||||
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
|
||||
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
|
||||
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
|
||||
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
|
||||
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
|
||||
// "resolveJsonModule": true, /* Enable importing .json files. */
|
||||
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
|
||||
|
||||
/* JavaScript Support */
|
||||
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
|
||||
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
|
||||
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
|
||||
|
||||
/* Emit */
|
||||
"declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
|
||||
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
|
||||
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
|
||||
"sourceMap": true, /* Create source map files for emitted JavaScript files. */
|
||||
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
|
||||
"outDir": "./built/", /* Specify an output folder for all emitted files. */
|
||||
// "removeComments": true, /* Disable emitting comments. */
|
||||
// "noEmit": true, /* Disable emitting files from a compilation. */
|
||||
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
|
||||
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
|
||||
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
|
||||
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
|
||||
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
|
||||
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
|
||||
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
|
||||
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
|
||||
// "newLine": "crlf", /* Set the newline character for emitting files. */
|
||||
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
|
||||
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
|
||||
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
|
||||
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
|
||||
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
|
||||
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
|
||||
|
||||
/* Interop Constraints */
|
||||
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
|
||||
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
|
||||
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
|
||||
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
|
||||
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
|
||||
|
||||
/* Type Checking */
|
||||
"strict": true, /* Enable all strict type-checking options. */
|
||||
"noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
|
||||
"strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
|
||||
"strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
|
||||
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
|
||||
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
|
||||
"noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
|
||||
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
|
||||
"alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
|
||||
"noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
|
||||
"noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
|
||||
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
|
||||
"noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
|
||||
"noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
|
||||
"noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
|
||||
"noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
|
||||
"noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
|
||||
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
|
||||
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
|
||||
|
||||
/* Completeness */
|
||||
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
|
||||
"skipLibCheck": true /* Skip type checking all .d.ts files. */
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user