From 94524229fc87954a7f31e766ae4ea21a4d94f74b Mon Sep 17 00:00:00 2001 From: James Date: Tue, 2 May 2023 19:57:37 +0100 Subject: [PATCH] fix: require getLessons options argument (#24) --- .changeset/config.json | 2 +- .changeset/cool-actors-attend.md | 5 ++ .changeset/green-apes-grin.md | 5 ++ .prettierignore | 4 +- package.json | 23 ++++--- src/core/baseClient.ts | 2 +- src/index.ts | 2 +- tsconfig.json | 112 ++++++------------------------- 8 files changed, 47 insertions(+), 108 deletions(-) create mode 100644 .changeset/cool-actors-attend.md create mode 100644 .changeset/green-apes-grin.md diff --git a/.changeset/config.json b/.changeset/config.json index 3a6c8db..cee6df8 100644 --- a/.changeset/config.json +++ b/.changeset/config.json @@ -1,7 +1,7 @@ { "$schema": "https://unpkg.com/@changesets/config@2.3.0/schema.json", "changelog": "@changesets/cli/changelog", - "commit": true, + "commit": false, "fixed": [], "linked": [], "access": "public", diff --git a/.changeset/cool-actors-attend.md b/.changeset/cool-actors-attend.md new file mode 100644 index 0000000..e99d4ca --- /dev/null +++ b/.changeset/cool-actors-attend.md @@ -0,0 +1,5 @@ +--- +"classcharts-api": patch +--- + +Require getLesson options argument diff --git a/.changeset/green-apes-grin.md b/.changeset/green-apes-grin.md new file mode 100644 index 0000000..4672a1a --- /dev/null +++ b/.changeset/green-apes-grin.md @@ -0,0 +1,5 @@ +--- +"classcharts-api": patch +--- + +Tidy up code diff --git a/.prettierignore b/.prettierignore index 29b5243..2c98acd 100644 --- a/.prettierignore +++ b/.prettierignore @@ -2,7 +2,5 @@ dist docs node_modules pnpm-lock.yaml -package.json .prettierrc.json -.eslint.js -tsconfig.json \ No newline at end of file +.eslint.js \ No newline at end of file diff --git a/package.json b/package.json index 87198e6..b262ed1 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,12 @@ "name": "classcharts-api", "type": "module", "version": "2.1.2", - "description": "A typescript wrapper for getting information from the Classcharts API", + "license": "ISC", + "author": { + "name": "James Cook", + "email": "james@jaminit.co.uk" + }, + "description": "A Typescript wrapper for getting information from the Classcharts API", "keywords": [ "node", "typescript", @@ -16,21 +21,16 @@ "type": "git", "url": "https://github.com/classchartsapi/classcharts-api-js.git" }, - "main": "./dist/index.js", + "homepage": "https://classchartsapi.github.io/classcharts-api-js/", "scripts": { "build": "tsc", "generateDocs": "typedoc --options typedoc.config.cjs", "test": "jest", "release": "pnpm run build && changeset publish" }, - "author": "James Cook", - "license": "ISC", "dependencies": { "ky-universal": "^0.11.0" }, - "files": [ - "dist/**" - ], "devDependencies": { "@changesets/cli": "^2.26.1", "@types/jest": "^29.5.1", @@ -47,13 +47,18 @@ "typedoc-plugin-umami": "^1.2.0", "typescript": "^5.0.4" }, + "main": "./dist/index.js", "types": "./dist/index.d.ts", "exports": { ".": { "import": "./dist/index.js", - "require": "./dist/index.js" + "require": "./dist/index.js", + "types": "./dist/index.d.ts" }, "./types": "./dist/index.d.ts", "./package.json": "./package.json" - } + }, + "files": [ + "dist/**" + ] } diff --git a/src/core/baseClient.ts b/src/core/baseClient.ts index 6a301ec..ca6f2fa 100644 --- a/src/core/baseClient.ts +++ b/src/core/baseClient.ts @@ -244,7 +244,7 @@ export class BaseClient { * @param options GetLessonsOptions * @returns Array of lessons */ - async getLessons(options?: GetLessonsOptions): Promise { + async getLessons(options: GetLessonsOptions): Promise { if (!options?.date) throw new Error("No date specified"); const params = new URLSearchParams(); params.append("date", String(options?.date)); diff --git a/src/index.ts b/src/index.ts index 97b2b06..2e1bbfb 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,6 +1,6 @@ export * from "./core/studentClient.js"; export * from "./core/parentClient.js"; -export { +export type { Student, ActivityPoint, BehaviourTimelinePoint, diff --git a/tsconfig.json b/tsconfig.json index d0269c0..346da08 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,96 +1,22 @@ { "compilerOptions": { - /* Visit https://aka.ms/tsconfig.json to read more about this file */ - /* Projects */ - // "incremental": true, /* Enable incremental compilation */ - // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ - // "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */ - // "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": "es2021" /* 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. */ - /* Modules */ - "module": "ES2020" /* Specify what module code is generated. */, - // "rootDir": "./", /* Specify the root folder within your source files. */ - "moduleResolution": "nodenext", /* 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. */ - // "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": "dist" /* 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. */ - /* 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, /* Type catch clause variables as 'unknown' instead of 'any'. */ - // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ - // "noUnusedLocals": true, /* Enable error reporting when a 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, /* Include 'undefined' in index signature results */ - // "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. */ + "target": "es2021", + "module": "ES2020", + "moduleResolution": "node", + "declaration": true, + "sourceMap": true, + "outDir": "dist", + "allowSyntheticDefaultImports": true, + "esModuleInterop": true, + "forceConsistentCasingInFileNames": true, + "strict": true, + "noImplicitAny": true, + "noImplicitReturns": true, + "noImplicitThis": true, + "noUnusedLocals": true, + "noUnusedParameters": true, + "skipLibCheck": true, + "isolatedModules": true }, - "exclude": [ - "tests", - "dist" - ] -} \ No newline at end of file + "include": ["./src/**/*"] +}