diff --git a/.gitignore b/.gitignore index cdf195e..e63b865 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,6 @@ node_modules/ .node_modules/ -built/* +**/built/* tests/cases/rwc/* tests/cases/test262/* tests/cases/perf/* diff --git a/README.md b/README.md index 0026aa8..7c97713 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,39 @@ # d4h-typescript Typescript library for accessing D4H + +## How to Consume +This library is not in NPM. As a result, you need to add it to your project locally. To do so, you have three options: +1. Add the repository to the consuming repository as a Git submodule. +2. Clone the repository locally. +3. Copy the files locally, without maintaining a Git repository. + +Regardless of which option you choose, you can add the package by running: + +`npm i /path/to/package/d4h-typescript/lib` + +Using a relative path will also work without issue. + +## Structure +The source code is broken into two main folders: +1. lib +2. test + +The lib folder contains the actual package intended for consumption. + +The test folder contains a simple test program that consumes the main package. This is not intended for unit tests, nor does it use any test framework. It is valuable as a validating and debugging tool as changes are made. + +### lib + +The only available command is to build: + +`npm run build` + +The output folder is the `built` directory. + +### test + +The available commands are: +* build: `npm run build` +* launch: `npm run launch` + +Build simply builds the test project, while launch both builds and runs it. If you've made changes to lib, be sure to build there first. \ No newline at end of file diff --git a/index.ts b/lib/index.ts similarity index 64% rename from index.ts rename to lib/index.ts index b2d971f..3c02c59 100644 --- a/index.ts +++ b/lib/index.ts @@ -1,4 +1,5 @@ -export default './src/d4h.js'; +import D4H from './src/d4h.js'; +export default D4H; export * from './src/d4h.js' export * from './src/group.js' diff --git a/package.json b/lib/package.json similarity index 91% rename from package.json rename to lib/package.json index 0ac96c2..7b556b4 100644 --- a/package.json +++ b/lib/package.json @@ -3,7 +3,6 @@ "version": "1.0.0", "main": "./built/index.js", "license": "MIT", - "type": "module", "scripts": { "build": "npx tsc" }, diff --git a/src/d4h.ts b/lib/src/d4h.ts similarity index 100% rename from src/d4h.ts rename to lib/src/d4h.ts diff --git a/src/group.ts b/lib/src/group.ts similarity index 100% rename from src/group.ts rename to lib/src/group.ts diff --git a/src/httpUtils.ts b/lib/src/httpUtils.ts similarity index 87% rename from src/httpUtils.ts rename to lib/src/httpUtils.ts index a05d896..e33ef31 100644 --- a/src/httpUtils.ts +++ b/lib/src/httpUtils.ts @@ -46,8 +46,8 @@ export default class HttpUtils { let offset = 0; while (true) { let urlWithOffset = new URL(url); - url.searchParams.append('offset', offset.toString()); - url.searchParams.append('limit', this._fetchLimit.toString()); + urlWithOffset.searchParams.append('offset', offset.toString()); + urlWithOffset.searchParams.append('limit', this._fetchLimit.toString()); let newResults = await this.get(urlWithOffset); results = results.concat(newResults); diff --git a/src/member.ts b/lib/src/member.ts similarity index 100% rename from src/member.ts rename to lib/src/member.ts diff --git a/tsconfig.json b/lib/tsconfig.json similarity index 96% rename from tsconfig.json rename to lib/tsconfig.json index 3363ec0..c6bff04 100644 --- a/tsconfig.json +++ b/lib/tsconfig.json @@ -25,7 +25,7 @@ // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ /* Modules */ - "module": "commonjs", /* Specify what module code is generated. */ + "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. */ @@ -44,12 +44,12 @@ // "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. */ + "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. */ + "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. */ + "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. */ diff --git a/test/config.ts b/test/config.ts new file mode 100644 index 0000000..4527b00 --- /dev/null +++ b/test/config.ts @@ -0,0 +1,3 @@ +export default { + d4hToken: "", +} \ No newline at end of file diff --git a/test/index.ts b/test/index.ts new file mode 100644 index 0000000..fc9f165 --- /dev/null +++ b/test/index.ts @@ -0,0 +1,30 @@ +import D4H, { GetMembersOptions } from "d4h-typescript" +import Config from "./config" + +let api = new D4H(Config.d4hToken); + +let getMembersOptions: GetMembersOptions = { + includeDetails: true, + includeCustomFields: true, +}; + +let main = async function() { + try { + let members = await api.getMembers(getMembersOptions); + console.log(`Retrieved ${members.length} members.`); + } catch (err) { + console.log(JSON.stringify(err)); + return; + } + + try { + let groups = await api.getGroups(); + console.log(`Retrieved ${groups.length} groups.`); + } catch (err) { + console.log(JSON.stringify(err)); + return; + } + +} + +main().then(() => console.log("Execution complete")); \ No newline at end of file diff --git a/test/package.json b/test/package.json new file mode 100644 index 0000000..701faa9 --- /dev/null +++ b/test/package.json @@ -0,0 +1,16 @@ +{ + "name": "d4h-typescript-test", + "version": "1.0.0", + "main": "./built/index.js", + "license": "MIT", + "scripts": { + "build": "npx tsc", + "launch": "npm run build && node ./built" + }, + "devDependencies": { + "typescript": "^4.8.4" + }, + "dependencies": { + "d4h-typescript": "file:../lib" + } +} diff --git a/test/tsconfig.json b/test/tsconfig.json new file mode 100644 index 0000000..ce798b4 --- /dev/null +++ b/test/tsconfig.json @@ -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 ''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. */ + } +}