Merge pull request #28 from data-depot/staging

chore: release

.github/CODEOWNERS

@@ -0,0 +1,12 @@
+/src/ @deanban @walleXD
+/package.json @walleXD
+/.github/workflows/ @walleXD
+/config/ @walleXD
+/.eslintrc.js @walleXD
+/.gitignore @walleXD
+/.nvmrc @walleXD
+/jest.config.js @walleXD
+/LICENSE @walleXD @deanban
+/README.md @walleXD @deanban
+/release.config.js @walleXD
+/tsconfig.json @walleXD

README.md

@@ -14,6 +14,8 @@ functional SoQL wrapper to interact with Open Data API
 ```bash
 # for js
 yarn add ramda rxjs soda-ts
+# for the adventurous 🤷🏼‍♂️
+yarn add https://github.com/data-depot/soda-ts.git
 # for ts
 yarn add -D @types/ramda
 ```
@@ -33,7 +35,10 @@ import { createQuery } from 'soda-ts'
 const query = createQuery({ src: 'w7w3-xahh' })
 
 // to pull from other domains
-const query = createQuery({ domain: 'data.cityofchicago.org', src: 'ydr8-5enu' })
+const query = createQuery({
+  domain: 'data.cityofchicago.org',
+  src: 'ydr8-5enu'
+})
 ```
 
 A raw `query` is the most primitive form of query.

package.json

@@ -1,4 +1,5 @@
 {
+  "version": "0.1.6",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -9,6 +10,14 @@
   "engines": {
     "node": ">=10"
   },
+  "keywords": [
+    "soda",
+    "opendata",
+    "socrata",
+    "rxjs",
+    "typescript",
+    "javascript"
+  ],
   "scripts": {
     "start": "tsdx watch",
     "build": "tsdx build",
@@ -49,6 +58,7 @@
   "author": "[email protected]",
   "repository": "https://github.com/data-depot/soda-ts",
   "homepage": "https://github.com/data-depot/soda-ts",
+  "description": "Seamlessly interact with OpenData APIs in TS or JS",
   "module": "dist/soda-ts.esm.js",
   "devDependencies": {
     "@commitlint/config-conventional": "^8.3.4",

release.config.js

@@ -1,26 +1,29 @@
 module.exports = {
-  "dryRun": false,
-  "plugins": [
-    "@semantic-release/commit-analyzer",
-    "@semantic-release/release-notes-generator",
+  dryRun: false,
+  branches: ['master'],
+  plugins: [
+    '@semantic-release/commit-analyzer',
+    '@semantic-release/release-notes-generator',
     [
-      "@semantic-release/changelog",
+      '@semantic-release/changelog',
       {
-        "changelogFile": "docs/CHANGELOG.md"
+        changelogFile: 'docs/CHANGELOG.md'
       }
     ],
-    "@semantic-release/npm",
-    "@semantic-release/github",
+    '@semantic-release/npm',
+    '@semantic-release/github',
     [
-      "@semantic-release/git",
+      '@semantic-release/git',
       {
-        "assets": [
-          "docs/CHANGELOG.md",
-          "package.json",
-          "package-lock.json"
+        assets: [
+          'docs/CHANGELOG.md',
+          'package.json',
+          'package-lock.json'
         ],
-        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+        message:
+          // eslint-disable-next-line no-template-curly-in-string
+          'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}'
       }
     ]
   ]
-};
+}

src/manager.ts

@@ -15,7 +15,7 @@ const logger = debug('soda-ts:manager')
 // unifity them and resuse nested types as needed
 
 /** options for pagiantion manager creation */
-interface ManagerOpts {
+export interface ManagerOpts {
   /** pagiantion item limits */
   limit: number
   /** items to offset by for req */
@@ -25,7 +25,7 @@ interface ManagerOpts {
 }
 
 /** options for pagination */
-interface PaginationOpts {
+export interface PaginationOpts {
   limit: number
   pageSize: number
   offset: number
@@ -141,12 +141,9 @@ export const createManagerCreator = <T>(
  * @param subject subject used to publish acquired data
  *
  */
-export const autoPaginator = async <T>(
-  // TODO: BREAKING CHANGE: turn it into a properly curryable fn like autoPaginator$
-  // this fn would fit that well within flow with pipe
-  manager: Manager<T>,
+export const autoPaginator = <T>(
   subject: Subject<T[]>
-): Promise<void> => {
+) => async (manager: Manager<T>): Promise<void> => {
   let currentPageSize = 0
   do {
     try {
@@ -172,6 +169,5 @@ export const autoPaginator = async <T>(
  */
 export const autoPaginator$ = <T>(
   subject: Subject<T[]>
-) => (manager: Manager<T>): Observable<void> => {
-  return defer(() => from(autoPaginator(manager, subject)))
-}
+) => (manager: Manager<T>): Observable<void> =>
+  defer(() => from(autoPaginator(subject)(manager)))

src/query.ts

@@ -1,10 +1,12 @@
+import { of, Observable } from 'rxjs'
+
 // local
 import { Query } from './types'
 
 /**
  * options for the `createQuery` fn
  */
-interface QueryOpts {
+export interface QueryOpts {
   /** source data id */
   src: string
   /** domain of data source */
@@ -18,7 +20,7 @@ interface QueryOpts {
  *
  * @param queryOpts options to create a query w/
  *
- * @returns `Query` curried fn used by runners & managers to make requests
+ * @returns `Query` used by runners & managers to make requests
  */
 export const createQuery = ({
   src,
@@ -30,3 +32,14 @@ export const createQuery = ({
   apiPath: apiPath ?? 'resource',
   clauses: []
 })
+
+/**
+ * create Query Observable for SODA req
+ *
+ * @param queryOpts options to create a query w/
+ *
+ * @returns `Query` Observable
+ */
+export const createQuery$ = (
+  opts: QueryOpts
+): Observable<Query> => of(createQuery(opts))

src/runner.ts

@@ -36,9 +36,10 @@ const logger = debug('soda-ts:runner')
  *  runner
  * )(query)
  */
-export const createRunner = <T>(
-  authOpts?: AuthOpts
-) => async (query: Query): Promise<T> => {
+export const createRunner = <T>({
+  appToken,
+  keysCamelCased
+}: AuthOpts = {}) => async (query: Query): Promise<T> => {
   const url = `https://${query.domain}/${query.apiPath}/${query.src}.json`
 
   logger(`making req to url: ${url}`)
@@ -59,8 +60,8 @@ export const createRunner = <T>(
   )
 
   const headers = {
-    ...(authOpts?.appToken && {
-      'X-App-Token': authOpts?.appToken
+    ...(appToken && {
+      'X-App-Token': appToken
     })
   }
 
@@ -79,7 +80,7 @@ export const createRunner = <T>(
       })
       .json<T>()
 
-    if (authOpts?.keysCamelCased) {
+    if (keysCamelCased) {
       return camelCaseKeys(res)
     } else {
       return res

test/manager.test.ts

@@ -101,7 +101,7 @@ describe('manager', () => {
         done()
       })
 
-      await autoPaginator(manager, paginatorSubject)
+      await autoPaginator(paginatorSubject)(manager)
     })
 
     // eslint-disable-next-line jest/no-test-callback
@@ -118,7 +118,7 @@ describe('manager', () => {
         }
       })
 
-      await autoPaginator(manager, paginatorSubject)
+      await autoPaginator(paginatorSubject)(manager)
     })
 
     // eslint-disable-next-line jest/no-test-callback
@@ -135,7 +135,7 @@ describe('manager', () => {
         }
       })
 
-      await autoPaginator(newManager, paginatorSubject)
+      await autoPaginator(paginatorSubject)(newManager)
     })
 
     // eslint-disable-next-line jest/no-test-callback
@@ -159,7 +159,7 @@ describe('manager', () => {
         }
       })
 
-      await autoPaginator(manager, paginatorSubject)
+      await autoPaginator(paginatorSubject)(manager)
     })
 
     // eslint-disable-next-line jest/no-test-callback
@@ -184,7 +184,7 @@ describe('manager', () => {
         }
       })
 
-      await autoPaginator(manager, paginatorSubject)
+      await autoPaginator(paginatorSubject)(manager)
     })
 
     // eslint-disable-next-line jest/no-test-callback

test/query.test.ts

@@ -1,4 +1,4 @@
-import { createQuery } from '../src'
+import { createQuery, createQuery$ } from '../src'
 
 const SRC = 'w7w3-xahh'
 const DOMAIN = 'data.cityofnewyork.us'
@@ -54,4 +54,10 @@ describe('query', () => {
 
     expect(query.domain).toBe('TEST')
   })
+
+  it('createQUery$', () => {
+    createQuery$({ src: SRC }).subscribe((val) => {
+      expect(val.src).toBe(SRC)
+    })
+  })
 })