Merge pull request #4 from GitbookIO/release-please--branches--main--…

…changes--next--components--lightswitch-api

release: 0.1.0-alpha.1

.devcontainer/Dockerfile

@@ -0,0 +1,23 @@
+# syntax=docker/dockerfile:1
+FROM debian:bookworm-slim AS stainless
+
+RUN apt-get update && apt-get install -y \
+  nodejs \
+  npm \
+  yarnpkg \
+  && apt-get clean autoclean
+
+# Ensure UTF-8 encoding
+ENV LANG=C.UTF-8
+ENV LC_ALL=C.UTF-8
+
+# Yarn
+RUN ln -sf /usr/bin/yarnpkg /usr/bin/yarn
+
+WORKDIR /workspace
+
+COPY package.json yarn.lock /workspace/
+
+RUN yarn install
+
+COPY . /workspace

.devcontainer/devcontainer.json

@@ -0,0 +1,20 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/debian
+{
+  "name": "Debian",
+  "build": {
+    "dockerfile": "Dockerfile"
+  }
+
+  // Features to add to the dev container. More info: https://containers.dev/features.
+  // "features": {},
+
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
+
+  // Configure tool-specific properties.
+  // "customizations": {},
+
+  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+  // "remoteUser": "root"
+}

.eslintrc.js

@@ -0,0 +1,29 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint', 'unused-imports', 'prettier'],
+  rules: {
+    'no-unused-vars': 'off',
+    'prettier/prettier': 'error',
+    'unused-imports/no-unused-imports': 'error',
+    'no-restricted-imports': [
+      'error',
+      {
+        patterns: [
+          {
+            group: ['lightswitch-api', 'lightswitch-api/*'],
+            message: 'Use a relative import, not a package import.',
+          },
+        ],
+      },
+    ],
+  },
+  overrides: [
+    {
+      files: ['tests/**', 'examples/**'],
+      rules: {
+        'no-restricted-imports': 'off',
+      },
+    },
+  ],
+  root: true,
+};

.github/workflows/ci.yml

@@ -0,0 +1,66 @@
+name: CI
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+      - next
+
+jobs:
+  lint:
+    name: lint
+    runs-on: ubuntu-latest
+
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+
+      - name: Bootstrap
+        run: ./scripts/bootstrap
+
+      - name: Check types
+        run: ./scripts/lint
+
+  build:
+    name: build
+    runs-on: ubuntu-latest
+
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+
+      - name: Bootstrap
+        run: ./scripts/bootstrap
+
+      - name: Check build
+        run: ./scripts/build
+  test:
+    name: test
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+
+      - name: Bootstrap
+        run: ./scripts/bootstrap
+
+      - name: Run tests
+        run: ./scripts/test
+

.github/workflows/publish-npm.yml

@@ -0,0 +1,32 @@
+# This workflow is triggered when a GitHub release is created.
+# It can also be run manually to re-publish to NPM in case it failed for some reason.
+# You can run this workflow by navigating to https://www.github.com/GitbookIO/lightswitch/actions/workflows/publish-npm.yml
+name: Publish NPM
+on:
+  workflow_dispatch:
+
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    name: publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Install dependencies
+        run: |
+          yarn install
+
+      - name: Publish to NPM
+        run: |
+          bash ./bin/publish-npm
+        env:
+          NPM_TOKEN: ${{ secrets.LIGHTSWITCH_NPM_TOKEN || secrets.NPM_TOKEN }}

.github/workflows/release-doctor.yml

@@ -0,0 +1,22 @@
+name: Release Doctor
+on:
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  release_doctor:
+    name: release doctor
+    runs-on: ubuntu-latest
+    if: github.repository == 'GitbookIO/lightswitch' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next')
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Check release environment
+        run: |
+          bash ./bin/check-release-environment
+        env:
+          NPM_TOKEN: ${{ secrets.LIGHTSWITCH_NPM_TOKEN || secrets.NPM_TOKEN }}
+

.gitignore

@@ -1,2 +1,10 @@
-node_modules/
-.env
+.prism.log
+node_modules
+yarn-error.log
+codegen.log
+Brewfile.lock.json
+dist
+dist-deno
+/*.tgz
+.idea/
+

.prettierignore

@@ -0,0 +1,7 @@
+CHANGELOG.md
+/ecosystem-tests/*/**
+/node_modules
+/deno
+
+# don't format tsc output, will break source maps
+/dist

.prettierrc.json

@@ -0,0 +1,7 @@
+{
+  "arrowParens": "always",
+  "experimentalTernaries": true,
+  "printWidth": 110,
+  "singleQuote": true,
+  "trailingComma": "all"
+}

.release-please-manifest.json

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

.stats.yml

@@ -0,0 +1,2 @@
+configured_endpoints: 7
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lightswitch%2Flightswitch-6dc2430da32f769677553172dba258ce0d23e8a260f803a5667d344159e8f57a.yml

Brewfile

@@ -0,0 +1 @@
+brew "node"

CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+## 0.1.0-alpha.1 (2025-02-05)
+
+Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/GitbookIO/lightswitch/compare/v0.0.1-alpha.0...v0.1.0-alpha.1)
+
+### Features
+
+* **api:** update via SDK Studio ([#5](https://github.com/GitbookIO/lightswitch/issues/5)) ([5a079e7](https://github.com/GitbookIO/lightswitch/commit/5a079e7ed3650a5a32741bfb9fe070f4f7db1341))
+* **api:** update via SDK Studio ([#6](https://github.com/GitbookIO/lightswitch/issues/6)) ([c17a038](https://github.com/GitbookIO/lightswitch/commit/c17a038ebbd38cba6b3eb3f4335dd0a117c0dde8))
+* **api:** update via SDK Studio ([#7](https://github.com/GitbookIO/lightswitch/issues/7)) ([7fcb271](https://github.com/GitbookIO/lightswitch/commit/7fcb2717d397559237df277732d1249a09d08b5f))
+* **api:** update via SDK Studio ([#8](https://github.com/GitbookIO/lightswitch/issues/8)) ([f1cf215](https://github.com/GitbookIO/lightswitch/commit/f1cf21575e46ad208bbcaa17e0f038962b2d5254))
+
+
+### Chores
+
+* go live ([#1](https://github.com/GitbookIO/lightswitch/issues/1)) ([ee6938b](https://github.com/GitbookIO/lightswitch/commit/ee6938b2a0bd79748e6b5d9ab2ac62c27058512f))
+* sync repo ([a99d060](https://github.com/GitbookIO/lightswitch/commit/a99d060d74d6f6effc3124f481b5430062d448a8))
+* update SDK settings ([#3](https://github.com/GitbookIO/lightswitch/issues/3)) ([5033f0f](https://github.com/GitbookIO/lightswitch/commit/5033f0f53999f97430546d4dbf481258538d3bba))

CONTRIBUTING.md

@@ -0,0 +1,107 @@
+## Setting up the environment
+
+This repository uses [`yarn@v1`](https://classic.yarnpkg.com/lang/en/docs/install).
+Other package managers may work but are not officially supported for development.
+
+To set up the repository, run:
+
+```sh
+$ 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.
+
+```ts
+// add an example to examples/<your-example>.ts
+
+#!/usr/bin/env -S npm run tsn -T
+…
+```
+
+```sh
+$ chmod +x examples/<your-example>.ts
+# run the example against your api
+$ yarn tsn -T examples/<your-example>.ts
+```
+
+## Using the repository from source
+
+If you’d like to use the repository from source, you can either install from git or link to a cloned repository:
+
+To install via git:
+
+```sh
+$ npm install git+ssh://git@github.com:GitbookIO/lightswitch.git
+```
+
+Alternatively, to link a local copy of the repo:
+
+```sh
+# Clone
+$ git clone https://www.github.com/GitbookIO/lightswitch
+$ cd lightswitch
+
+# With yarn
+$ yarn link
+$ cd ../my-package
+$ yarn link lightswitch-api
+
+# With pnpm
+$ pnpm link --global
+$ cd ../my-package
+$ pnpm link -—global lightswitch-api
+```
+
+## 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.
+
+```sh
+$ npx prism mock path/to/your/openapi.yml
+```
+
+```sh
+$ 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:
+
+```sh
+$ yarn lint
+```
+
+To format and fix all lint issues automatically:
+
+```sh
+$ 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 with a GitHub workflow
+
+You can release to package managers by using [the `Publish NPM` GitHub action](https://www.github.com/GitbookIO/lightswitch/actions/workflows/publish-npm.yml). This requires a setup organization or repository secret to be set up.
+
+### 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.