initial commit

Author: djMax

.github/workflows/npm_publish.yml

@@ -0,0 +1,47 @@
+name: Publish npm Package
+
+on:
+  push:
+    branches:
+      - main
+
+permissions: read-all
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - run: yarn install --immutable
+      - run: yarn build
+      - run: yarn lint
+      - run: yarn test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      issues: write
+      id-token: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          registry-url: https://registry.npmjs.org/
+      - run: yarn install --immutable
+      - run: yarn build
+
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          yarn dlx semantic-release

.github/workflows/pull_requests.yml

@@ -0,0 +1,22 @@
+name: Build and run tests
+
+on:
+  pull_request:
+    types: [assigned, opened, synchronize, reopened]
+
+permissions: read-all
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - run: yarn install --immutable
+      - run: yarn build
+      - run: yarn lint
+      - run: yarn test

.gitignore

@@ -0,0 +1,32 @@
+test_output.log
+.idea
+node_modules
+build
+coverage
+.nyc_output
+*.log
+.tap_output
+__tests__/petstore.d.ts
+
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+.node_repl_history
+
+# TypeScript incremental compilation cache
+*.tsbuildinfo
+.eslintcache
+
+# Added by coconfig
+.eslintignore
+.npmignore
+tsconfig.json
+tsconfig.build.json
+jest.config.js
+.prettierrc.js
+.eslintrc.js
+.commitlintrc.json

.yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs

@@ -0,0 +1,7 @@
+nodeLinker: node-modules
+
+plugins:
+  - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
+    spec: '@yarnpkg/plugin-interactive-tools'
+
+yarnPath: .yarn/releases/yarn-3.6.1.cjs

.yarn/releases/yarn-3.6.1.cjs

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 openapi-typescript-infra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

.yarnrc.yml

@@ -0,0 +1,12 @@
+.PHONY: all
+
+all: __tests__/petstore.d.ts
+
+__tests__/petstore.d.ts: __tests__/petstore.json
+	yarn dlx openapi-typescript ./__tests__/petstore.json -o ./__tests__/petstore.d.ts
+	@echo "/* eslint-disable */" > lint-swap.txt
+	@cat __tests__/petstore.d.ts >> lint-swap.txt
+	@mv lint-swap.txt __tests__/petstore.d.ts
+
+clean:
+	rm -f __tests__/petstore.d.ts

LICENSE

@@ -0,0 +1,3 @@
+# openapi-typescript-enum
+
+This module adds a transformer to openapi-typescript that generates real enums in addition to the typed unions.

Makefile

@@ -0,0 +1,11 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.x.x   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+File a GitHub issue for any discovered vulnerabilities, or email [email protected] if it needs to be private.

README.md

@@ -0,0 +1,89 @@
+import { InMemoryLRUCache } from '@apollo/utils.keyvaluecache';
+
+import { type JsonPutBody, TypedRESTDataSource } from '../src/index';
+
+import type { paths } from './petstore';
+
+interface ApolloContext {
+  petId: number;
+}
+
+class PetStoreDataSource extends TypedRESTDataSource<paths, ApolloContext> {
+  override baseURL = 'https://petstore3.swagger.io/api/v3';
+
+  protected willSendRequest() {}
+
+  callSimpleMethod() {
+    return this.openapi.GET(
+      '/pet/{petId}',
+      {
+        params: {
+          path: {
+            petId: this.context.petId,
+          },
+        },
+      },
+      {
+        cacheOptions: {
+          ttl: 100000,
+        },
+      },
+    );
+  }
+
+  uploadBadImage() {
+    return this.openapi.POST('/pet/{petId}/uploadImage', {
+      params: {
+        path: { petId: 1 },
+        query: { additionalMetadata: 'test' },
+      },
+      body: 'binarydata',
+    });
+  }
+}
+
+test('should create a client', async () => {
+  const petStore = new PetStoreDataSource();
+  const cache = new InMemoryLRUCache();
+  expect(petStore).toBeInstanceOf(PetStoreDataSource);
+  petStore.initialize({
+    context: { petId: 1 },
+    cache,
+  });
+
+  const response = await petStore.callSimpleMethod();
+  expect(response.name).toBe('Pet1');
+  expect(cache.keys()).toHaveLength(1);
+
+  const response2 = await petStore.callSimpleMethod();
+  expect(response2.name).toBe('Pet1');
+  expect(cache.keys()).toHaveLength(1);
+
+  const reqSpy = jest.spyOn(
+    petStore as unknown as { willSendRequest: () => void },
+    'willSendRequest',
+  );
+
+  await petStore.uploadBadImage().catch((error) => {
+    expect(error.extensions?.response).toBeTruthy();
+    expect(error.extensions?.response.status).toBe(415);
+  });
+
+  expect(reqSpy).toHaveBeenCalledTimes(1);
+  expect(reqSpy).toHaveBeenCalledWith(
+    expect.objectContaining({
+      method: 'POST',
+      path: '/pet/1/uploadImage',
+      body: 'binarydata',
+      params: new URLSearchParams({ additionalMetadata: 'test' }),
+    }),
+  );
+
+  // This is essentially a build time test.
+  const body: JsonPutBody<paths['/pet']> = {
+    id: 1,
+    name: 'Kiki',
+    photoUrls: [],
+  };
+  expect(body).toBeTruthy();
+});