08 Directory Structure

Directory Structure

Note

This is to help developers working on this package.
None of this information is needed if you are just using the package.

.
├── .github/
|   ├── config/
|   |   └── dep-report.json5                # Configure options for NPM Dep Report workflow.
|   ├── helpers/
|   |   ├── github-api/                     # Functions to access the GitHub API.
|   |   ├── create-npm-dep-report-issues.js # Creates GitHub Issues for Npm Dep Reports workflow.
|   |   ├── create-npm-dep-report.js        # Creates text bodies for Npm Dep Reports workflow.
|   |   ├── parse-json5-config.js           # Parses json5 files for GitHub workflows output.
|   |   └── parse-npm-deps.js               # Parses package.json files for changes to package versions.
|   ├── workflows/
|   |   ├── npm-dep-report.yaml             # Reports on new package versions.
|   |   └── releases.yaml                   # Creates a new GitHub Release and publishes to NPM.
├── scripts/
|   ├── bump-version.mjs                    # Bumps version in package.json file.
|   ├── remove-dts-files.mjs                # Removes TypeScript declaration files from the build.
|   └── remove-empty-dirs.mjs               # Removes empty directories from the build.
├── src/                                    # Source code for package.
|   ├── utils/                              # Utility functions.
|   ├── config.ts                           # Config variables.
|   ├── integration.ts                      # Functions for endpoints under the Integrations section of the swagger docs.
|   ├── index.ts                            # Export functions for the package.
|   ├── roleMapping.ts                      # Functions for endpoints under the Role Mapping section of the swagger docs.
|   ├── roles.ts                            # Functions for endpoints under the Roles section of the swagger docs.
|   ├── users.ts                            # Functions for endpoints under the Users section of the swagger docs.
|   └── types.ts                            # TypeScript types.
├── package.json                            # Package config and dependencies.
├── .npmrc                                  # NPM config.
├── rollup.config.mjs                       # Builds and compiles TypeScript files into JavaScript.
├── rollupdts.config.mjs                    # Builds and compiles TypeScript declaration files.