feat: create docs & client ready for npm release

Author: SgtPooki

.aegir.cjs

@@ -1,6 +1,3 @@
-// import { MockServer } from './test/MockServer'
-
-// let mockServer = new MockServer()
 require('ts-node').register({
   project: 'tsconfig.json',
 })

.gitignore

@@ -1,6 +1,7 @@
 node_modules
 typings
 dist
+dist.generated
 build
 coverage
 node_modules
@@ -15,3 +16,5 @@ package-lock.json
 .nyc_output
 generated/fetch/package.json
 generated/fetch/tsconfig.json
+tsconfig-types.aegir.tsbuildinfo
+docs

README.md

@@ -14,16 +14,16 @@ This client only has a programmatic API at the moment (no CLI). You use it like
 
 ```ts
 
-import { Configuration, PinsApi, Status } from '@ipfs-shipyard/pinning-service-client'
+import { Configuration, RemotePinningServiceClient, Status } from '@ipfs-shipyard/pinning-service-client'
 import type { PinsGetRequest, PinResults } from '@ipfs-shipyard/pinning-service-client'
 
 const config = new Configuration({
-  basePath, // the URI for your pinning provider, e.g. `http://localhost:3000`
+  endpointUrl, // the URI for your pinning provider, e.g. `http://localhost:3000`
   accessToken, // the secret token/key given to you by your pinning provider
   // fetchApi: fetch, // You can pass your own fetchApi implementation, but we use fetch-ponyfill by default.
 })
 
-const client = new PinsApi(config)
+const client = new RemotePinningServiceClient(config)
 
 (async () => {
   // Get 10 failed Pins

package.json

@@ -23,7 +23,7 @@
     "node": ">=16.0.0",
     "npm": ">=7.0.0"
   },
-  "main": "src/index.js",
+  "main": "src/index.ts",
   "types": "dist/src/index.d.ts",
   "typesVersions": {
     "*": {
@@ -41,7 +41,8 @@
   },
   "files": [
     "src",
-    "dist"
+    "dist",
+    "dist.generated"
   ],
   "eslintConfig": {
     "extends": "ipfs",
@@ -131,7 +132,7 @@
     ]
   },
   "scripts": {
-    "clean": "npx rimraf dist generated node_modules",
+    "clean": "npx rimraf dist generated node_modules .swc",
     "ci:test": "run-s test:*",
     "dep-check": "aegir dep-check src/**/*.ts test/**/*.ts generated/**/*.ts",
     "fix": "run-s fix:*",
@@ -142,10 +143,10 @@
     "lint-TODO:project": "check-aegir-project # currently broken due to corrupting the repoUrl",
     "release": "aegir release",
     "postinstall": "run-s gen",
-    "build": "aegir build",
-    "build2": "tsc-silent -p tsconfig.generated.json --suppress 6133@generated 6192@generated --stats",
+    "build": "run-s build:* && cp-cli dist.generated dist/dist.generated",
+    "build-todo:docs": "aegir docs -p false",
+    "build:deps": "run-s gen",
     "build:main": "aegir build",
-    "build:docs": "aegir ts docs",
     "build:types": "aegir ts -p types",
     "test": "run-s test:*",
     "test:browser": "aegir test --target browser",
@@ -160,39 +161,41 @@
     "gen:ts": "openapi-generator-cli generate --generator-key ts"
   },
   "dependencies": {
-    "fetch-ponyfill": "^7.1.0",
-    "yargs": "^17.3.1"
+    "fetch-ponyfill": "^7.1.0"
   },
   "devDependencies": {
     "@openapitools/openapi-generator-cli": "^2.4.26",
-    "@swc/core": "^1.2.144",
+    "@swc/cli": "^0.1.55",
+    "@swc/core": "^1.2.157",
     "@swc/helpers": "^0.3.3",
     "@types/cors": "^2.8.12",
     "@types/express": "^4.17.13",
     "@types/mocha": "^9.1.0",
     "@types/node": "^17.0.21",
     "@types/portscanner": "^2.1.1",
-    "aegir": "^36.1.3",
+    "aegir": "^36.2.2",
     "check-aegir-project": "^1.0.3",
     "cors": "^2.8.5",
+    "cp-cli": "^2.0.0",
     "dotenvrc": "^1.0.1",
     "express": "^4.17.3",
     "express-promise-router": "^4.1.1",
     "mock-ipfs-pinning-service": "^0.4.0",
     "npm-run-all": "^4.1.5",
-    "openapi-typescript": "^5.1.1",
     "portscanner": "^2.2.0",
     "regenerator-runtime": "^0.13.9",
-    "ts-node": "^10.5.0",
+    "ts-node": "^10.7.0",
     "tsc-silent": "^1.2.1",
     "winston": "^3.6.0"
   },
   "exports": {
     ".": {
-      "import": "./generated/api.ts"
+      "import": "./dist/src/index.js",
+      "require": "./dist/src/index.js"
     },
     "./api/apis": {
-      "import": "./generated/api/apis.ts"
+      "import": "./dist/dist.generated/apis",
+      "require": "./dist/dist.generated/apis"
     }
   }
 }

src/index.ts

@@ -1,23 +1,58 @@
 import fetchPonyfill from 'fetch-ponyfill'
-import { Configuration as GeneratedConfiguration } from '../generated/fetch/dist/src'
-import type { ConfigurationParameters } from '../generated/fetch/dist/src'
 
-export * from '../generated/fetch/dist/src/apis'
-export * from '../generated/fetch/dist/src/models'
+import { Configuration as GeneratedConfiguration } from '../dist.generated'
+import type { ConfigurationParameters as GeneratedConfigurationParameters } from '../dist.generated'
+import { PinsApi as RemotePinningServiceClient } from '../dist.generated/apis'
 
-export class Configuration extends GeneratedConfiguration {
+interface ConfigurationParameters extends Omit<GeneratedConfigurationParameters, 'basePath'>{
+  endpointUrl?: string
+}
+class Configuration extends GeneratedConfiguration {
   constructor (options: ConfigurationParameters) {
+    const finalOptions: GeneratedConfigurationParameters = { ...options }
+
     /**
      * Prevent the need for everyone to have to override the fetch API...
      */
     if (options.fetchApi == null) {
-      options.fetchApi = fetchPonyfill().fetch
+      finalOptions.fetchApi = fetchPonyfill().fetch
+    }
+
+    // @see https://github.com/ipfs-shipyard/js-pinning-service-http-client/issues/3
+    if (options.endpointUrl != null) {
+      finalOptions.basePath = options.endpointUrl
     }
-    super(options)
+
+    super(finalOptions)
   }
 }
 
+/**
+ * Overwritten and renamed exports
+ */
+export type {
+  PinsApiInterface as RemotePinningServiceClientInterface
+} from '../dist.generated/apis'
+
+export {
+  Configuration,
+  RemotePinningServiceClient
+}
 export type { ConfigurationParameters }
+
+/**
+ * Unmodified exports
+ */
+export type {
+  PinsGetRequest,
+  PinsPostRequest,
+  PinsRequestidDeleteRequest,
+  PinsRequestidGetRequest,
+  PinsRequestidPostRequest
+} from '../dist.generated/apis'
+
+export * from '../dist.generated/models'
+
 export {
   BASE_PATH,
   BaseAPI,
@@ -32,4 +67,15 @@ export {
   exists,
   mapValues,
   querystring
-} from '../generated/fetch/dist/src/runtime'
+} from '../dist.generated/runtime'
+
+export type {
+  FetchParams,
+  RequestOpts,
+  Consume,
+  RequestContext,
+  ResponseContext,
+  Middleware,
+  ApiResponse,
+  ResponseTransformer
+} from '../dist.generated/runtime'

test/MockServerController.ts

@@ -28,7 +28,7 @@ class MockServerController {
          */
         res.send({
           success: true,
-          basePath: mockServer.basePath,
+          endpointUrl: mockServer.basePath,
           accessToken: process.env.MOCK_PINNING_SERVER_SECRET
         })
       } catch (error) {

test/client.spec.ts

@@ -1,30 +1,30 @@
 /* eslint-env browser, node, mocha */
 
 import { expect } from 'aegir/utils/chai'
-import { Configuration, PinsApi, Status } from '../src'
+import { Configuration, RemotePinningServiceClient, Status } from '../src'
 import type { Pin } from '../src'
 import fetchPonyfill from 'fetch-ponyfill'
 
 const { fetch } = fetchPonyfill()
 
 let Config = new Configuration({
-  basePath: 'http://127.0.0.1:3000',
+  endpointUrl: 'http://127.0.0.1:3000',
   // fetchApi: fetch,
   accessToken: process.env.MOCK_PINNING_SERVER_SECRET
 })
 describe('Client', () => {
   it('Can be instantiated', () => {
-    expect(() => new PinsApi(Config)).not.to.throw()
+    expect(() => new RemotePinningServiceClient(Config)).not.to.throw()
   })
 
   describe('Operations', () => {
     // let mockServer: MockServer
     // let Config: Configuration
     beforeEach(async () => {
       const response = await fetch('http://localhost:3000/start')
-      const { basePath, accessToken } = await response.json()
+      const { endpointUrl, accessToken } = await response.json()
       Config = new Configuration({
-        basePath,
+        endpointUrl,
         accessToken
         // fetchApi: fetch
       })
@@ -42,13 +42,13 @@ describe('Client', () => {
     })
 
     it('GET: Can get failed Pins', async () => {
-      const Client = new PinsApi(Config)
+      const Client = new RemotePinningServiceClient(Config)
       const response = await Client.pinsGet({ limit: 1, status: new Set([Status.Failed]) })
       expect(response).to.deep.eq({ count: 0, results: new Set() })
     })
 
     it('GET: Can add a Pin successfully', async () => {
-      const Client = new PinsApi(Config)
+      const Client = new RemotePinningServiceClient(Config)
       const pin: Pin = {
         cid: 'abc123',
         name: 'pinned-test1'
@@ -59,7 +59,7 @@ describe('Client', () => {
     })
 
     it('POST: Can handle a failed pinning', async () => {
-      const Client = new PinsApi(Config)
+      const Client = new RemotePinningServiceClient(Config)
       const pin: Pin = {
         cid: 'abc123',
         name: 'failed-test2'

tsconfig.generated.json

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "sourceRoot": "generated/fetch/src",
-    "outDir": "generated/fetch/dist",
+    "outDir": "dist.generated",
     "emitDeclarationOnly": false,
     "module": "ES2020",
     "target": "ES2020",
@@ -15,7 +15,7 @@
     "noUnusedLocals": false,
     "noUnusedParameters": false,
     "isolatedModules": false,
-    "rootDir": "generated/fetch",
+    "rootDir": "generated/fetch/src",
     "sourceMap": true,
     "moduleResolution":"Node"
 

tsconfig.json

@@ -7,7 +7,7 @@
     "typeRoots": [
       "./types",
       "./node_modules/@types",
-      "./generated/fetch/dist"
+      "dist/dist.generated"
     ],
     "noEmitOnError": true,
     "esModuleInterop": true,
@@ -20,7 +20,7 @@
     "test/**/*.ts",
     "types/**/*.d.ts",
     "MockServer.ts",
-    "./generated/fetch/dist"
+    "dist/dist.generated"
   ],
   "exclude": [
     "generated"