@onesignal/node-onesignal 1.0.0-beta4 → 1.0.0-beta5

package/.github/ISSUE_TEMPLATE/ask-question.yml

@@ -0,0 +1,25 @@
+name: 🙋‍♂️ Ask a question
+description: Tell us what's on your mind
+title: "[question]: "
+labels: ["triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Having issues integrating this API library?
+  - type: textarea
+    id: question
+    attributes:
+      label: How can we help?
+      description: Specific question regarding integrating this API library.
+      placeholder: How do I...?
+    validations:
+      required: true
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

package/.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,51 @@
+name: 🪳 Bug report
+description: File a bug report
+title: "[Bug]: "
+labels: ["bug", "triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Provide a thorough description of whats going on.
+      placeholder: The latest version of the API library throws an exception when creating a notification targetting all Active Users.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction-steps
+    attributes:
+      label: Steps to reproduce?
+      description: Provide as much detail as posible to reproduce the issue.
+      placeholder: |
+        1. Install vX.Y.Z of dependency
+        2. Run provided code snippet
+        3. Note that the app crashes
+      render: Markdown
+    validations:
+      required: true
+  - type: textarea
+    id: what-are-expectations
+    attributes:
+      label: What did you expect to happen?
+      description: Also tell us, what did you expect to happen?
+      placeholder: I expected the API library to properly deserialize any response returned by OneSignal.
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: Shell
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

package/.github/ISSUE_TEMPLATE/general-feedback.yml

@@ -0,0 +1,25 @@
+name: 📣 General feedback
+description: Tell us what's on your mind
+title: "[Bug]: "
+labels: ["triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for sharing your valuable feedback!
+  - type: textarea
+    id: feedback
+    attributes:
+      label: What's on your mind?
+      description: Feedback regarding this API library.
+      placeholder: Share your feedback...
+    validations:
+      required: true
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

package/.github/pull_request_template.md

@@ -0,0 +1,44 @@
+<!-- START -->
+# READ AND DELETE THIS SECTION BEFORE SUBMITTING PR
+* **Fill out each _REQUIRED_ section**
+* **Fill out _OPTIONAL_ sections, remove section if it doesn't apply to your PR**
+* **Read and fill out each of the checklists below**
+* **Remove this section after reading**
+<!-- END -->
+
+# Description
+## One Line Summary
+**REQUIRED** - Very short description that summaries the changes in this PR.
+
+## Details
+
+### Motivation
+**REQUIRED -** Why is this code change being made? Or what is the goal of this PR? Examples: Fixes a specific bug, provides additional logging to debug future issues, feature to allow X.
+
+### Scope
+**RECOMMEND - OPTIONAL -** What is intended to be effected. What is known not to change. Example: Notifications are grouped when parameter X is set, not enabled by default.
+
+### OPTIONAL - Other
+**OPTIONAL -** Feel free to add any other sections or sub-sections that can explain your PR better.
+
+# Testing
+
+## Manual testing
+**REQUIRED -** Explain what scenarios were tested and the environment.
+
+
+# Checklist
+## Overview
+   - [ ] I have filled out all **REQUIRED** sections above
+   - [ ] PR does one thing
+     - If it is hard to explain how any codes changes are related to each other then it most likely needs to be more than one PR
+   - [ ] Any Public API changes are explained in the PR details and conform to existing APIs
+
+## Testing
+   - [ ] I have personally tested this on my device, or explained why that is not possible
+
+## Final pass
+   - [ ] Code is as readable as possible.
+      - Simplify with less code, followed by splitting up code into well named functions and variables, followed by adding comments to the code.
+   - [ ] I have reviewed this PR myself, ensuring it meets each checklist item
+      - WIP (Work In Progress) is ok, but explain what is still in progress and what you would like feedback on. Start the PR title with "WIP" to indicate this.

package/.github/workflows/npm_deploy.yml

@@ -0,0 +1,21 @@
+name: NPM Publish
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Install Node types
+        run: npm install @types/node
+      - name: Publish package
+        if: github.event_name == 'release' && github.event.action == 'created'
+        uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.NPM }}

package/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## January 2022
+
+### `1.0.0-beta4` - 02/25/2022
+#### Added
+- .npmignore file
+
+#### Fixed
+- Missing `dist` directory since npm was ignoring it due to lack of .npmignore
+
+### `1.0.0-beta5` - 10/1/2022
+#### Api Changes
+- Configuration setup has been simplified and streamlined. Now it looks like this:
+  ```js
+    const configuration = OneSignal.createConfiguration({
+        userKey: USER_KEY_TOKEN,
+        appKey: APP_KEY_TOKEN,
+    });
+  ```
+- Player ID is no longer required when creating a player
+
+#### Fixed
+- Bug in the OpenAPI schema not allowing users to use filters when creating a notification.
+- Bug in the OpenAPI schema not allowing to set the notification name.