@space-df/sdk 0.0.1-dev.3.3 → 0.0.1-dev.5

package/.editorconfig

@@ -0,0 +1,24 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+max_line_length = 160
+quote_type = single
+
+[*.json]
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_size = 8
+indent_style = tab

package/.github/pull_request_template.md

@@ -0,0 +1,25 @@
+## What?
+
+<!-- Explain the changes you've made in this pull request. Provide a brief summary of the features, bug fixes, or refactors included. -->
+
+## Why?
+
+<!-- Describe the business or technical reason behind these changes. What goal does this PR achieve? -->
+
+## How?
+
+<!-- Detail how the changes were implemented. Include specifics on the code, technologies, or processes used. -->
+
+## Testing?
+
+-   [ ] Functional Testing
+-   [ ] Accessibility
+-   [ ] Performance
+-   [ ] Code Quality
+-   [ ] Security
+-   [ ] Documentation
+-   [ ] Final Review
+
+## Anything Else?
+
+<!-- Add any further context, suggestions, or future considerations. -->

package/.github/workflows/bump-version.yml

@@ -0,0 +1,67 @@
+name: Version Bump and Pull Request
+
+on:
+    push:
+        branches: [main]
+
+jobs:
+    version_bump:
+        if: github.event.commits[0].author.username != 'github-actions[bot]'
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
+
+            - name: Set up Git
+              run: |
+                  git config --global user.name 'github-actions[bot]'
+                  git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+
+            - name: Bump version
+              id: bump_version
+              run: |
+                  version=$(npm version prerelease --preid=dev --no-git-tag-version)
+                  echo "bumped_version=${version}" >> $GITHUB_ENV
+
+            - name: Update src/version.ts
+              run: |
+                  echo "export const VERSION = '${{ env.bumped_version }}';" > src/version.ts
+                  git add src/version.ts
+
+            - name: Create new branch
+              run: |
+                  git checkout -b "${{ env.bumped_version }}"
+                  npm install
+                  npm run build
+                  git add src/version.ts
+                  git commit -m"${{ env.bumped_version }}"
+                  git push origin "${{ env.bumped_version }}"
+
+            - name: Create Pull Request
+              id: cpr
+              uses: peter-evans/create-pull-request@v5
+              with:
+                  token: ${{ secrets.GITHUB_TOKEN }}
+                  branch: '${{ env.bumped_version }}'
+                  commit-message: '${{ env.bumped_version }}'
+                  committer: 'github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>'
+                  author: 'github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>'
+                  title: 'Bump version to ${{ env.bumped_version }}'
+                  body: 'This pull request bumps the version to ${{ env.bumped_version }}.'
+                  base: main
+                  labels: 'dev'
+
+            - name: Auto approve
+              if: steps.cpr.outputs.pull-request-operation == 'created'
+              run: gh pr review --approve "${{ steps.cpr.outputs.pull-request-number }}"
+              env:
+                  GH_TOKEN: ${{ secrets.GH_PACKAGE }}
+
+            - name: Request Automerge
+              if: steps.cpr.outputs.pull-request-operation == 'created'
+              uses: peter-evans/enable-pull-request-automerge@v3
+              with:
+                  token: ${{ secrets.GH_PACKAGE }}
+                  pull-request-number: ${{ steps.cpr.outputs.pull-request-number }}
+                  merge-method: squash

package/.github/workflows/publish-package.yml

@@ -0,0 +1,28 @@
+name: Publish to npm
+
+on:
+    push:
+        branches: [main]
+
+jobs:
+    publish:
+        if: github.event.commits[0].author.username == 'github-actions[bot]'
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: '20'
+                  registry-url: 'https://registry.npmjs.org'
+
+            - name: Install dependencies
+              run: npm install
+
+            - run: npm run build
+            - run: cd dist
+
+            - name: Publish to npm
+              run: npm publish --access public
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.gitignore

@@ -0,0 +1,11 @@
+node_modules
+codegen.log
+Brewfile.lock.json
+dist
+/deno
+/*.tgz
+
+.vscode
+
+.DS_Store
+.env

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

package/CONTRIBUTING.md

@@ -0,0 +1,89 @@
+## Setting up the environment
+
+This repository uses [`yarn@v1`](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable).
+Other package managers may work but are not officially supported for development.
+
+To set up the repository, run:
+
+```bash
+yarn
+yarn build
+```
+
+This will install all the required dependencies and build output files to `dist/`.
+
+## Modifying/Adding code
+
+Most of the SDK is generated code. Modifications to code will be persisted between generations, but may
+result in merge conflicts between manual patches and changes from the generator. The generator will never
+modify the contents of the `src/lib/` and `examples/` directories.
+
+## Adding and running examples
+
+All files in the `examples/` directory are not modified by the generator and can be freely edited or added to.
+
+```bash
+// add an example to examples/<your-example>.ts
+
+#!/usr/bin/env -S npm run tsn -T
+…
+```
+
+```
+chmod +x examples/<your-example>.ts
+# run the example against your api
+yarn tsn -T examples/<your-example>.ts
+```
+
+# With yarn
+
+yarn link
+cd ../my-package
+yarn link @space-df/sdk
+
+# With pnpm
+
+pnpm link --global
+cd ../my-package
+pnpm link -—global @space-df/sdk
+
+````
+
+## Running tests
+
+Most tests require you to [set up a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests.
+
+```bash
+npx prism mock path/to/your/openapi.yml
+````
+
+```bash
+yarn run test
+```
+
+## Linting and formatting
+
+This repository uses [prettier](https://www.npmjs.com/package/prettier) and
+[eslint](https://www.npmjs.com/package/eslint) to format the code in the repository.
+
+To lint:
+
+```bash
+yarn lint
+```
+
+To format and fix all lint issues automatically:
+
+```bash
+yarn fix
+```
+
+## Publishing and releases
+
+Changes made to this repository via the automated release PR pipeline should publish to npm automatically. If
+the changes aren't made through the automated pipeline, you may want to make releases manually.
+
+### Publish manually
+
+If you need to manually release a package, you can run the `bin/publish-npm` script with an `NPM_TOKEN` set on
+the environment.