ts-japi 1.6.1 → 1.7.0

package/.commitlintrc.ts

@@ -0,0 +1,3 @@
+export default {
+  extends: ['@commitlint/config-conventional'],
+};

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,21 +1,20 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: "[BUG] {{issue name}}"
+title: '[BUG] {{issue name}}'
 labels: bug
 assignees: jun-sheaf
-
 ---
 
-## Describe the bug<sup>*</sup>
+## Describe the bug<sup>\*</sup>
 
 {{A clear and concise description of what the bug is.}}
 
-## To Reproduce<sup>*</sup>
+## To Reproduce<sup>\*</sup>
 
 {{Add steps/examples to reproduce the behavior.}}
 
-## Expected behavior<sup>*</sup>
+## Expected behavior<sup>\*</sup>
 
 {{A clear and concise description of what you expected to happen.}}
 
@@ -23,7 +22,7 @@ assignees: jun-sheaf
 
 {{Add screenshots to help explain your problem.}}
 
-## Platform<sup>*</sup>
+## Platform<sup>\*</sup>
 
 - [ ] OS: {{ Write the OS name and its version }}
 - [ ] Browser {{ Write the browser name and its version }}

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,21 +1,20 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: "[FR] {{feature request name}}"
+title: '[FR] {{feature request name}}'
 labels: enhancement
 assignees: jun-sheaf
-
 ---
 
-## Is your feature request related to a problem? <sup>*</sup>
+## Is your feature request related to a problem? <sup>\*</sup>
 
 {{A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]}}
 
-## Describe the solution you'd like<sup>*</sup>
+## Describe the solution you'd like<sup>\*</sup>
 
 {{A clear and concise description of what you want to happen.}}
 
-## Describe alternatives you've considered<sup>*</sup>
+## Describe alternatives you've considered<sup>\*</sup>
 
 {{A clear and concise description of any alternative solutions or features you've considered.}}
 

package/.github/ISSUE_TEMPLATE/request-for-comments.md

@@ -1,24 +1,23 @@
 ---
 name: Request for comments
 about: Request for comments around the community.
-title: "[RFC] {{RFC name}}"
+title: '[RFC] {{RFC name}}'
 labels: good first issue, question
 assignees: jun-sheaf
-
 ---
 
-## Summary<sup>*</sup>
+## Summary<sup>\*</sup>
 
 {{One paragraph explanation of the change}}
 
-## Motivation<sup>*</sup>
+## Motivation<sup>\*</sup>
 
 {{
 Why are we doing this? What use cases does it support? What is the expected
 outcome?
 }}
 
-## Design Detail<sup>*</sup>
+## Design Detail<sup>\*</sup>
 
 {{
  Explain the design in enough detail for somebody familiar with the
@@ -27,7 +26,7 @@ and can include examples of how the service is used. Any new terminology should
 be defined here.
 }}
 
-## Drawbacks<sup>*</sup>
+## Drawbacks<sup>\*</sup>
 
 {{
  Why should we *not* do this? Please consider the impact on users, on the
@@ -35,50 +34,38 @@ integration of this change with other existing and planned features etc. There
 are tradeoffs to choosing any path, please attempt to identify them here.
 }}
 
-## Rationale and Alternatives<sup>*</sup>
+## Rationale and Alternatives<sup>\*</sup>
 
-{{
- Why is this design the best in the space of possible designs?
+{{ Why is this design the best in the space of possible designs?
 
- What other designs have been considered and what is the rationale for not
- choosing them?
+What other designs have been considered and what is the rationale for not choosing them?
 
- What is the impact of not doing this?
-}}
+What is the impact of not doing this? }}
 
-## Prior Art<sup>*</sup>
+## Prior Art<sup>\*</sup>
 
-{{
- Discuss prior art, both the good and the bad, in relation to this proposal. A
- few examples of what this can include are:
-
- {{
-  How other services / infrastructures in the same domain have solved this
-  problem.
-
-  Are there any published papers or great posts that discuss this? If you have
-  some relevant papers to refer to, this can serve as a more detailed
-  theoretical background.
- }}
-
- This section is intended to encourage you as an author to think about the
- lessons from other organisations, provide readers of your RFC with a fuller
- picture. If there is no prior art, that is fine - your ideas are interesting
- whether they are brand new or if it is an adaptation from other services.
-}}
+{{ Discuss prior art, both the good and the bad, in relation to this proposal. A few examples of
+what this can include are:
 
-## Unresolved questions<sup>*</sup>
+{{ How other services / infrastructures in the same domain have solved this problem.
 
-{{
- What parts of the design do you expect to resolve through the RFC process
- before this gets merged?
+Are there any published papers or great posts that discuss this? If you have some relevant papers to
+refer to, this can serve as a more detailed theoretical background. }}
 
- What parts of the design do you expect to resolve through the implementation of
- this feature before stabilisation?
+This section is intended to encourage you as an author to think about the lessons from other
+organisations, provide readers of your RFC with a fuller picture. If there is no prior art, that is
+fine - your ideas are interesting whether they are brand new or if it is an adaptation from other
+services. }}
 
- What related issues do you consider out of scope for this RFC that could be
- addressed in the future independently of the solution that comes out of this
- RFC?
-}}
+## Unresolved questions<sup>\*</sup>
+
+{{ What parts of the design do you expect to resolve through the RFC process before this gets
+merged?
+
+What parts of the design do you expect to resolve through the implementation of this feature before
+stabilisation?
+
+What related issues do you consider out of scope for this RFC that could be addressed in the future
+independently of the solution that comes out of this RFC? }}
 
 \* means required.

package/.github/release-please.yml

@@ -0,0 +1,4 @@
+releaseType: node
+primaryBranch: main
+handleGHRelease: true
+manifest: true

package/.github/workflows/ci.yaml

@@ -0,0 +1,73 @@
+name: CI
+
+# Declare default permissions as read only.
+permissions: read-all
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '**'
+
+concurrency:
+  group: ${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  inspect-code:
+    name: Inspect code
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+      - name: Set up Node.js
+        uses: actions/setup-node@v3.4.1
+        with:
+          node-version: 18
+      - name: Install dependencies
+        run: yarn install  --frozen-lockfile
+      - name: Lint code
+        run: yarn lint
+      - name: Lint commits
+        run: yarn commitlint
+        if: github.event_name != 'pull_request'
+
+  tests:
+    name: ${{ matrix.spec.name }} tests (${{ matrix.spec.node }})
+    runs-on: ${{ matrix.spec.machine }}
+    continue-on-error: true
+    strategy:
+      matrix:
+        spec:
+          - name: Linux
+            machine: ubuntu-latest
+            node: 14
+          - name: Linux
+            machine: ubuntu-latest
+            node: 16
+          - name: Linux
+            machine: ubuntu-latest
+            node: 18
+          - name: macOS
+            machine: macos-latest
+            node: 14
+          - name: Windows
+            machine: windows-latest
+            node: 14
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Node.js
+        uses: actions/setup-node@v3.4.1
+        with:
+          node-version: ${{ matrix.spec.node }}
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Build
+        run: yarn build
+      - name: Test
+        run: yarn test

package/.github/workflows/publish.yaml

@@ -0,0 +1,29 @@
+name: Publish
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - v*
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Node.js
+        uses: actions/setup-node@v3.4.1
+        with:
+          node-version: 18
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Build
+        run: yarn build
+      - name: Publish
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn lint

package/.husky/pre-push

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn commitlint

package/.prettierignore

@@ -0,0 +1,2 @@
+CHANGELOG.md
+docs

package/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "1.7.0"
+}

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [1.7.0](https://github.com/mathematic-inc/ts-japi/compare/v1.6.3...v1.7.0) (2022-08-05)
+
+
+### Bug Fixes
+
+* ignore relationships if they're not set to support optional relations ([#49](https://github.com/mathematic-inc/ts-japi/issues/49)) ([7bd7d53](https://github.com/mathematic-inc/ts-japi/commit/7bd7d5372c96841583dce9bd01a8bbb4cb220b8e))
+
+## 1.6.2
+
+### Patch Changes
+
+- c5a8201: Add customisable relationship names
+
 ## 1.6.1
 
 ### Patch Changes
@@ -24,7 +37,7 @@
 
 ### Minor Changes
 
-- Fixes https://github.com/mu-io/ts-japi/issues/23
+- Fixes https://github.com/mathematic-inc/ts-japi/issues/23
 
 ## 1.4.0
 

package/Makefile

@@ -1,33 +1,7 @@
 PATH:=$(PATH):$(PWD)/node_modules/.bin
 SHELL:=env PATH=$(PATH) /bin/bash
 
-all: lib docs README.md
-
-lib: $(shell find src -name '*.ts')
-	@echo 'Building library...'
-	@tsc
-
-docs: $(shell find src -name '*.ts')
-	@echo 'Building documentation...'
-	@typedoc
-	@rsync -a ./src/docs/assets ./docs
-
-README.md: src/docs/README.md
-	@echo 'Building README...'
-	@typedoc --plugin typedoc-plugin-markdown --out ./md-docs --theme markdown
-	@mv md-docs/README.md README.md
-	@rm -rf md-docs
-	@ts-node scripts/readme-postbuild.ts
-
-clean: clean-docs clean-readme clean-build clean-coverage
-
-clean-docs:
-	@echo 'Cleaning documentation...'
-	@rm -rf ./docs
-
-clean-readme:
-	@echo 'Cleaning README...'
-	@rm -rf ./readme
+clean: clean-build clean-coverage
 
 clean-lib:
 	@echo 'Cleaning build artifacts...'