ts-japi 1.6.1 → 1.6.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (75) hide show
  1. package/CHANGELOG.md +7 -1
  2. package/Makefile +1 -27
  3. package/README.md +145 -75
  4. package/api-extractor.json +14 -0
  5. package/lib/classes/cache.d.ts +2 -2
  6. package/lib/classes/cache.js +26 -48
  7. package/lib/classes/cache.js.map +1 -1
  8. package/lib/classes/error-serializer.d.ts +6 -6
  9. package/lib/classes/error-serializer.js +58 -125
  10. package/lib/classes/error-serializer.js.map +1 -1
  11. package/lib/classes/linker.d.ts +5 -5
  12. package/lib/classes/linker.d.ts.map +1 -1
  13. package/lib/classes/linker.js +15 -41
  14. package/lib/classes/linker.js.map +1 -1
  15. package/lib/classes/metaizer.d.ts +4 -4
  16. package/lib/classes/metaizer.d.ts.map +1 -1
  17. package/lib/classes/metaizer.js +12 -38
  18. package/lib/classes/metaizer.js.map +1 -1
  19. package/lib/classes/paginator.d.ts +3 -3
  20. package/lib/classes/paginator.js +17 -16
  21. package/lib/classes/paginator.js.map +1 -1
  22. package/lib/classes/relator.d.ts +6 -6
  23. package/lib/classes/relator.d.ts.map +1 -1
  24. package/lib/classes/relator.js +70 -134
  25. package/lib/classes/relator.js.map +1 -1
  26. package/lib/classes/serializer.d.ts +9 -9
  27. package/lib/classes/serializer.js +213 -316
  28. package/lib/classes/serializer.js.map +1 -1
  29. package/lib/index.js +17 -10
  30. package/lib/index.js.map +1 -1
  31. package/lib/interfaces/cache.interface.d.ts +2 -2
  32. package/lib/interfaces/cache.interface.js +1 -1
  33. package/lib/interfaces/error-serializer.interface.d.ts +11 -11
  34. package/lib/interfaces/error-serializer.interface.js +1 -1
  35. package/lib/interfaces/error.interface.js +1 -1
  36. package/lib/interfaces/json-api.interface.js +1 -1
  37. package/lib/interfaces/linker.interface.d.ts +1 -1
  38. package/lib/interfaces/linker.interface.js +1 -1
  39. package/lib/interfaces/paginator.interface.js +1 -1
  40. package/lib/interfaces/relator.interface.d.ts +4 -4
  41. package/lib/interfaces/relator.interface.js +1 -1
  42. package/lib/interfaces/serializer.interface.d.ts +24 -24
  43. package/lib/interfaces/serializer.interface.js +1 -1
  44. package/lib/models/error.model.d.ts +1 -1
  45. package/lib/models/error.model.js +59 -22
  46. package/lib/models/error.model.js.map +1 -1
  47. package/lib/models/link.model.js +11 -10
  48. package/lib/models/link.model.js.map +1 -1
  49. package/lib/models/meta.model.js +5 -6
  50. package/lib/models/meta.model.js.map +1 -1
  51. package/lib/models/relationship.model.js +8 -6
  52. package/lib/models/relationship.model.js.map +1 -1
  53. package/lib/models/resource-identifier.model.js +11 -9
  54. package/lib/models/resource-identifier.model.js.map +1 -1
  55. package/lib/models/resource.model.js +13 -28
  56. package/lib/models/resource.model.js.map +1 -1
  57. package/lib/tsdoc-metadata.json +11 -0
  58. package/lib/types/global.types.js +1 -1
  59. package/lib/utils/is-error-document.d.ts +1 -1
  60. package/lib/utils/is-error-document.js +6 -8
  61. package/lib/utils/is-error-document.js.map +1 -1
  62. package/lib/utils/is-object.js +1 -1
  63. package/lib/utils/is-plain-object.js +4 -4
  64. package/lib/utils/is-plain-object.js.map +1 -1
  65. package/lib/utils/merge.d.ts +2 -2
  66. package/lib/utils/merge.js +16 -63
  67. package/lib/utils/merge.js.map +1 -1
  68. package/lib/utils/serializer.utils.js +56 -202
  69. package/lib/utils/serializer.utils.js.map +1 -1
  70. package/package.json +36 -30
  71. package/tools/generate_docs.ts +33 -0
  72. package/tools/internal/custom_markdown_action.ts +32 -0
  73. package/tools/internal/custom_markdown_documenter.ts +1337 -0
  74. package/tsconfig.json +60 -79
  75. package/CONTRIBUTING.md +0 -127
package/tsconfig.json CHANGED
@@ -1,81 +1,62 @@
1
1
  {
2
- "compilerOptions": {
3
- /* Basic Options */
4
- // "incremental": true, /* Enable incremental compilation */
5
- // "target": "es3", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
6
- "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
7
- "lib": [
8
- "es2020",
9
- "dom"
10
- ], /* Specify library files to be included in the compilation. */
11
- // "allowJs": true, /* Allow javascript files to be compiled. */
12
- // "checkJs": true, /* Report errors in .js files. */
13
- // "jsx": "react", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
14
- "declaration": true, /* Generates corresponding '.d.ts' file. */
15
- "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
16
- "sourceMap": true, /* Generates corresponding '.map' file. */
17
- // "outFile": "./", /* Concatenate and emit output to single file. */
18
- "outDir": "./lib/", /* Redirect output structure to the directory. */
19
- "rootDir": "./src/", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
20
- // "composite": true, /* Enable project compilation */
21
- // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
22
- // "removeComments": true, /* Do not emit comments to output. */
23
- // "noEmit": true, /* Do not emit outputs. */
24
- // "importHelpers": true, /* Import emit helpers from 'tslib'. */
25
- "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
26
- // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
27
- /* Strict Type-Checking Options */
28
- "strict": true, /* Enable all strict type-checking options. */
29
- "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
30
- "strictNullChecks": true, /* Enable strict null checks. */
31
- "strictFunctionTypes": true, /* Enable strict checking of function types. */
32
- "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
33
- "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
34
- "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
35
- "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
36
- /* Additional Checks */
37
- // "noUnusedLocals": true, /* Report errors on unused locals. */
38
- // "noUnusedParameters": true, /* Report errors on unused parameters. */
39
- "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
40
- "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
41
- /* Module Resolution Options */
42
- // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
43
- // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
44
- // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
45
- // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
46
- // "typeRoots": [], /* List of folders to include type definitions from. */
47
- // "types": [], /* Type declaration files to be included in compilation. */
48
- // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
49
- "esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
50
- "resolveJsonModule": true,
51
- // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
52
- // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
53
- /* Source Map Options */
54
- // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
55
- // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
56
- // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
57
- // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
58
- /* Experimental Options */
59
- // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
60
- // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
61
- /* Advanced Options */
62
- "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
63
- },
64
- "include": [
65
- "src"
66
- ],
67
- "typedocOptions": {
68
- "out": "docs",
69
- "entryPoints": [
70
- "./src/index.ts"
71
- ],
72
- "includes": [
73
- "./examples"
74
- ],
75
- "plugin": "none",
76
- "exclude": "**/*+(.spec|.e2e|.test).ts",
77
- "readme": "src/docs/README.md",
78
- "categorizeByGroup": true,
79
- "gitRevision": "master"
80
- }
2
+ "compilerOptions": {
3
+ "target": "esnext",
4
+ "module": "commonjs",
5
+ "lib": [
6
+ "es2020",
7
+ "dom"
8
+ ],
9
+ "declaration": true, /* Generates corresponding '.d.ts' file. */
10
+ "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
11
+ "sourceMap": true, /* Generates corresponding '.map' file. */
12
+ // "outFile": "./", /* Concatenate and emit output to single file. */
13
+ "outDir": "./lib/", /* Redirect output structure to the directory. */
14
+ "rootDir": "./src/", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
15
+ // "composite": true, /* Enable project compilation */
16
+ // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
17
+ // "removeComments": true, /* Do not emit comments to output. */
18
+ // "noEmit": true, /* Do not emit outputs. */
19
+ // "importHelpers": true, /* Import emit helpers from 'tslib'. */
20
+ "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
21
+ // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
22
+ /* Strict Type-Checking Options */
23
+ "strict": true, /* Enable all strict type-checking options. */
24
+ "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
25
+ "strictNullChecks": true, /* Enable strict null checks. */
26
+ "strictFunctionTypes": true, /* Enable strict checking of function types. */
27
+ "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
28
+ "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
29
+ "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
30
+ "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
31
+ /* Additional Checks */
32
+ // "noUnusedLocals": true, /* Report errors on unused locals. */
33
+ // "noUnusedParameters": true, /* Report errors on unused parameters. */
34
+ "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
35
+ "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
36
+ /* Module Resolution Options */
37
+ // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
38
+ // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
39
+ // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
40
+ // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
41
+ // "typeRoots": [], /* List of folders to include type definitions from. */
42
+ // "types": [], /* Type declaration files to be included in compilation. */
43
+ // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
44
+ "esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
45
+ "resolveJsonModule": true,
46
+ // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
47
+ // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
48
+ /* Source Map Options */
49
+ // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
50
+ // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
51
+ // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
52
+ // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
53
+ /* Experimental Options */
54
+ // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
55
+ // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
56
+ /* Advanced Options */
57
+ "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
58
+ },
59
+ "include": [
60
+ "src"
61
+ ]
81
62
  }
package/CONTRIBUTING.md DELETED
@@ -1,127 +0,0 @@
1
- # Contributor Covenant Code of Conduct
2
-
3
- ## Our Pledge
4
-
5
- We as members, contributors, and leaders pledge to make participation in our
6
- community a harassment-free experience for everyone, regardless of age, body
7
- size, visible or invisible disability, ethnicity, sex characteristics, gender
8
- identity and expression, level of experience, education, socio-economic status,
9
- nationality, personal appearance, race, religion, or sexual identity
10
- and orientation.
11
-
12
- We pledge to act and interact in ways that contribute to an open, welcoming,
13
- diverse, inclusive, and healthy community.
14
-
15
- ## Our Standards
16
-
17
- Examples of behavior that contributes to a positive environment for our
18
- community include:
19
-
20
- * Demonstrating empathy and kindness toward other people
21
- * Being respectful of differing opinions, viewpoints, and experiences
22
- * Giving and gracefully accepting constructive feedback
23
- * Accepting responsibility and apologizing to those affected by our mistakes,
24
- and learning from the experience
25
- * Focusing on what is best not just for us as individuals, but for the
26
- overall community
27
-
28
- Examples of unacceptable behavior include:
29
-
30
- * The use of sexualized language or imagery, and sexual attention or
31
- advances of any kind
32
- * Trolling, insulting or derogatory comments, and personal or political attacks
33
- * Public or private harassment
34
- * Publishing others' private information, such as a physical or email
35
- address, without their explicit permission
36
- * Other conduct which could reasonably be considered inappropriate in a
37
- professional setting
38
-
39
- ## Enforcement Responsibilities
40
-
41
- Community leaders are responsible for clarifying and enforcing our standards of
42
- acceptable behavior and will take appropriate and fair corrective action in
43
- response to any behavior that they deem inappropriate, threatening, offensive,
44
- or harmful.
45
-
46
- Community leaders have the right and responsibility to remove, edit, or reject
47
- comments, commits, code, wiki edits, issues, and other contributions that are
48
- not aligned to this Code of Conduct, and will communicate reasons for moderation
49
- decisions when appropriate.
50
-
51
- ## Scope
52
-
53
- This Code of Conduct applies within all community spaces, and also applies when
54
- an individual is officially representing the community in public spaces.
55
- Examples of representing our community include using an official e-mail address,
56
- posting via an official social media account, or acting as an appointed
57
- representative at an online or offline event.
58
-
59
- ## Enforcement
60
-
61
- Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
- reported to the community leaders responsible for enforcement at rjung@jeongjh.com.
63
- All complaints will be reviewed and investigated promptly and fairly.
64
-
65
- All community leaders are obligated to respect the privacy and security of the
66
- reporter of any incident.
67
-
68
- ## Enforcement Guidelines
69
-
70
- Community leaders will follow these Community Impact Guidelines in determining
71
- the consequences for any action they deem in violation of this Code of Conduct:
72
-
73
- ### 1. Correction
74
-
75
- **Community Impact**: Use of inappropriate language or other behavior deemed
76
- unprofessional or unwelcome in the community.
77
-
78
- **Consequence**: A private, written warning from community leaders, providing
79
- clarity around the nature of the violation and an explanation of why the
80
- behavior was inappropriate. A public apology may be requested.
81
-
82
- ### 2. Warning
83
-
84
- **Community Impact**: A violation through a single incident or series
85
- of actions.
86
-
87
- **Consequence**: A warning with consequences for continued behavior. No
88
- interaction with the people involved, including unsolicited interaction with
89
- those enforcing the Code of Conduct, for a specified period of time. This
90
- includes avoiding interactions in community spaces as well as external channels
91
- like social media. Violating these terms may lead to a temporary or
92
- permanent ban.
93
-
94
- ### 3. Temporary Ban
95
-
96
- **Community Impact**: A serious violation of community standards, including
97
- sustained inappropriate behavior.
98
-
99
- **Consequence**: A temporary ban from any sort of interaction or public
100
- communication with the community for a specified period of time. No public or
101
- private interaction with the people involved, including unsolicited interaction
102
- with those enforcing the Code of Conduct, is allowed during this period.
103
- Violating these terms may lead to a permanent ban.
104
-
105
- ### 4. Permanent Ban
106
-
107
- **Community Impact**: Demonstrating a pattern of violation of community
108
- standards, including sustained inappropriate behavior, harassment of an
109
- individual, or aggression toward or disparagement of classes of individuals.
110
-
111
- **Consequence**: A permanent ban from any sort of public interaction within
112
- the community.
113
-
114
- ## Attribution
115
-
116
- This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117
- version 2.0, available at
118
- https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
119
-
120
- Community Impact Guidelines were inspired by [Mozilla's code of conduct
121
- enforcement ladder](https://github.com/mozilla/diversity).
122
-
123
- [homepage]: https://www.contributor-covenant.org
124
-
125
- For answers to common questions about this code of conduct, see the FAQ at
126
- https://www.contributor-covenant.org/faq. Translations are available at
127
- https://www.contributor-covenant.org/translations.