ts-japi 1.12.1 → 1.12.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 (113) hide show
  1. package/.commitlintrc.ts +1 -1
  2. package/.github/workflows/ci.yml +32 -0
  3. package/.github/workflows/release-notes.yml +53 -0
  4. package/.github/workflows/{release-please.yaml → release-please.yml} +6 -7
  5. package/.github/workflows/release.yml +147 -0
  6. package/.node-version +1 -0
  7. package/.release-please-manifest.json +1 -1
  8. package/CHANGELOG.md +7 -0
  9. package/LICENSE +2 -1
  10. package/README.md +9 -7
  11. package/benchmarks/playground.benchmark.ts +12 -12
  12. package/benchmarks/serializer.benchmark.ts +10 -10
  13. package/biome.json +141 -0
  14. package/lefthook.yml +12 -0
  15. package/lib/classes/cache.d.ts +4 -4
  16. package/lib/classes/cache.d.ts.map +1 -1
  17. package/lib/classes/cache.js +7 -5
  18. package/lib/classes/cache.js.map +1 -1
  19. package/lib/classes/error-serializer.d.ts +3 -3
  20. package/lib/classes/error-serializer.d.ts.map +1 -1
  21. package/lib/classes/error-serializer.js +18 -15
  22. package/lib/classes/error-serializer.js.map +1 -1
  23. package/lib/classes/linker.d.ts +3 -3
  24. package/lib/classes/linker.d.ts.map +1 -1
  25. package/lib/classes/metaizer.d.ts +2 -2
  26. package/lib/classes/metaizer.d.ts.map +1 -1
  27. package/lib/classes/paginator.d.ts +5 -5
  28. package/lib/classes/paginator.d.ts.map +1 -1
  29. package/lib/classes/paginator.js +6 -5
  30. package/lib/classes/paginator.js.map +1 -1
  31. package/lib/classes/polymorphic-serialiser.d.ts +9 -10
  32. package/lib/classes/polymorphic-serialiser.d.ts.map +1 -1
  33. package/lib/classes/polymorphic-serialiser.js +15 -6
  34. package/lib/classes/polymorphic-serialiser.js.map +1 -1
  35. package/lib/classes/relator.d.ts +11 -11
  36. package/lib/classes/relator.d.ts.map +1 -1
  37. package/lib/classes/relator.js +15 -6
  38. package/lib/classes/relator.js.map +1 -1
  39. package/lib/classes/serializer.d.ts +9 -9
  40. package/lib/classes/serializer.d.ts.map +1 -1
  41. package/lib/classes/serializer.js +38 -27
  42. package/lib/classes/serializer.js.map +1 -1
  43. package/lib/index.d.ts +21 -21
  44. package/lib/index.d.ts.map +1 -1
  45. package/lib/index.js +9 -9
  46. package/lib/index.js.map +1 -1
  47. package/lib/interfaces/cache.interface.d.ts +1 -1
  48. package/lib/interfaces/cache.interface.d.ts.map +1 -1
  49. package/lib/interfaces/error-serializer.interface.d.ts +37 -37
  50. package/lib/interfaces/error-serializer.interface.d.ts.map +1 -1
  51. package/lib/interfaces/error.interface.d.ts +21 -21
  52. package/lib/interfaces/error.interface.d.ts.map +1 -1
  53. package/lib/interfaces/json-api.interface.d.ts +12 -12
  54. package/lib/interfaces/json-api.interface.d.ts.map +1 -1
  55. package/lib/interfaces/linker.interface.d.ts +1 -1
  56. package/lib/interfaces/linker.interface.d.ts.map +1 -1
  57. package/lib/interfaces/paginator.interface.d.ts +2 -2
  58. package/lib/interfaces/paginator.interface.d.ts.map +1 -1
  59. package/lib/interfaces/relator.interface.d.ts +3 -3
  60. package/lib/interfaces/relator.interface.d.ts.map +1 -1
  61. package/lib/interfaces/serializer.interface.d.ts +78 -78
  62. package/lib/interfaces/serializer.interface.d.ts.map +1 -1
  63. package/lib/models/error.model.d.ts +4 -4
  64. package/lib/models/error.model.d.ts.map +1 -1
  65. package/lib/models/error.model.js +29 -18
  66. package/lib/models/error.model.js.map +1 -1
  67. package/lib/models/link.model.d.ts +1 -1
  68. package/lib/models/link.model.d.ts.map +1 -1
  69. package/lib/models/relationship.model.d.ts +5 -5
  70. package/lib/models/relationship.model.d.ts.map +1 -1
  71. package/lib/models/relationship.model.js +8 -5
  72. package/lib/models/relationship.model.js.map +1 -1
  73. package/lib/models/resource-identifier.model.d.ts +1 -1
  74. package/lib/models/resource-identifier.model.d.ts.map +1 -1
  75. package/lib/models/resource-identifier.model.js +2 -1
  76. package/lib/models/resource-identifier.model.js.map +1 -1
  77. package/lib/models/resource.model.d.ts +5 -5
  78. package/lib/models/resource.model.d.ts.map +1 -1
  79. package/lib/models/resource.model.js +6 -3
  80. package/lib/models/resource.model.js.map +1 -1
  81. package/lib/types/global.types.d.ts +9 -9
  82. package/lib/types/global.types.d.ts.map +1 -1
  83. package/lib/utils/is-error-document.d.ts +1 -1
  84. package/lib/utils/is-error-document.d.ts.map +1 -1
  85. package/lib/utils/is-error-document.js +3 -4
  86. package/lib/utils/is-error-document.js.map +1 -1
  87. package/lib/utils/is-object.d.ts.map +1 -1
  88. package/lib/utils/is-object.js +3 -3
  89. package/lib/utils/is-object.js.map +1 -1
  90. package/lib/utils/is-plain-object.d.ts.map +1 -1
  91. package/lib/utils/is-plain-object.js +9 -6
  92. package/lib/utils/is-plain-object.js.map +1 -1
  93. package/lib/utils/merge.d.ts +1 -1
  94. package/lib/utils/merge.d.ts.map +1 -1
  95. package/lib/utils/merge.js +5 -3
  96. package/lib/utils/merge.js.map +1 -1
  97. package/lib/utils/serializer.utils.d.ts +4 -4
  98. package/lib/utils/serializer.utils.d.ts.map +1 -1
  99. package/lib/utils/serializer.utils.js +27 -22
  100. package/lib/utils/serializer.utils.js.map +1 -1
  101. package/package.json +53 -65
  102. package/release-please-config.json +8 -3
  103. package/tools/generate_docs.ts +7 -9
  104. package/tools/internal/custom_markdown_action.ts +3 -3
  105. package/tools/internal/custom_markdown_documenter.ts +348 -244
  106. package/tsconfig.json +4 -3
  107. package/.github/release-please.yml +0 -4
  108. package/.github/workflows/ci.yaml +0 -73
  109. package/.github/workflows/publish.yaml +0 -29
  110. package/.husky/pre-commit +0 -4
  111. package/.husky/pre-push +0 -4
  112. package/.prettierignore +0 -4
  113. package/.prettierrc +0 -10
package/tsconfig.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "compilerOptions": {
3
- "target": "esnext",
3
+ "target": "ESNext",
4
4
  "module": "commonjs",
5
- "lib": ["es2020", "dom"],
5
+ "lib": ["ESNext", "dom"],
6
6
  "declaration": true /* Generates corresponding '.d.ts' file. */,
7
7
  "declarationMap": true /* Generates a sourcemap for each corresponding '.d.ts' file. */,
8
8
  "sourceMap": true /* Generates corresponding '.map' file. */,
@@ -51,7 +51,8 @@
51
51
  // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
52
52
  // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
53
53
  /* Advanced Options */
54
- "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
54
+ "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */,
55
+ "skipLibCheck": true
55
56
  },
56
57
  "include": ["src"]
57
58
  }
@@ -1,4 +0,0 @@
1
- releaseType: node
2
- primaryBranch: main
3
- handleGHRelease: true
4
- manifest: true
@@ -1,73 +0,0 @@
1
- name: CI
2
-
3
- # Declare default permissions as read only.
4
- permissions: read-all
5
-
6
- on:
7
- push:
8
- branches:
9
- - main
10
- pull_request:
11
- branches:
12
- - '**'
13
-
14
- concurrency:
15
- group: ${{ github.head_ref || github.run_id }}
16
- cancel-in-progress: true
17
-
18
- jobs:
19
- inspect-code:
20
- name: Inspect code
21
- runs-on: ubuntu-latest
22
- steps:
23
- - name: Checkout
24
- uses: actions/checkout@v3
25
- with:
26
- fetch-depth: 2
27
- - name: Set up Node.js
28
- uses: actions/setup-node@v3.4.1
29
- with:
30
- node-version: 18
31
- - name: Install dependencies
32
- run: yarn install --frozen-lockfile
33
- - name: Lint code
34
- run: yarn lint
35
- - name: Lint commits
36
- run: yarn commitlint
37
- if: github.event_name != 'pull_request'
38
-
39
- tests:
40
- name: ${{ matrix.spec.name }} tests (${{ matrix.spec.node }})
41
- runs-on: ${{ matrix.spec.machine }}
42
- continue-on-error: true
43
- strategy:
44
- matrix:
45
- spec:
46
- - name: Linux
47
- machine: ubuntu-latest
48
- node: 14
49
- - name: Linux
50
- machine: ubuntu-latest
51
- node: 16
52
- - name: Linux
53
- machine: ubuntu-latest
54
- node: 18
55
- - name: macOS
56
- machine: macos-latest
57
- node: 16
58
- - name: Windows
59
- machine: windows-latest
60
- node: 14
61
- steps:
62
- - name: Checkout
63
- uses: actions/checkout@v3
64
- - name: Set up Node.js
65
- uses: actions/setup-node@v3.4.1
66
- with:
67
- node-version: ${{ matrix.spec.node }}
68
- - name: Install dependencies
69
- run: yarn install --frozen-lockfile
70
- - name: Build
71
- run: yarn build
72
- - name: Test
73
- run: yarn test
@@ -1,29 +0,0 @@
1
- name: Publish
2
-
3
- on:
4
- workflow_dispatch:
5
- push:
6
- tags:
7
- - v*
8
-
9
- jobs:
10
- publish:
11
- runs-on: ubuntu-latest
12
- permissions:
13
- contents: read
14
- steps:
15
- - name: Checkout
16
- uses: actions/checkout@v3
17
- - name: Set up Node.js
18
- uses: actions/setup-node@v3.4.1
19
- with:
20
- node-version: 18
21
- registry-url: 'https://registry.npmjs.org'
22
- - name: Install dependencies
23
- run: yarn install --frozen-lockfile
24
- - name: Build
25
- run: yarn build
26
- - name: Publish
27
- run: npm publish
28
- env:
29
- NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
package/.husky/pre-commit DELETED
@@ -1,4 +0,0 @@
1
- #!/usr/bin/env sh
2
- . "$(dirname -- "$0")/_/husky.sh"
3
-
4
- yarn lint
package/.husky/pre-push DELETED
@@ -1,4 +0,0 @@
1
- #!/usr/bin/env sh
2
- . "$(dirname -- "$0")/_/husky.sh"
3
-
4
- yarn commitlint
package/.prettierignore DELETED
@@ -1,4 +0,0 @@
1
- CHANGELOG.md
2
- docs
3
- lib
4
- coverage
package/.prettierrc DELETED
@@ -1,10 +0,0 @@
1
- printWidth: 100
2
- tabWidth: 2
3
- useTabs: false
4
- semi: true
5
- singleQuote: true
6
- quoteProps: 'consistent'
7
- trailingComma: 'es5'
8
- bracketSpacing: true
9
- arrowParens: 'always'
10
- proseWrap: 'always'