Merge pull request #19 from pubpub/feat/auth

.changeset/config.json

@@ -6,6 +6,5 @@
   "linked": [],
   "access": "public",
   "baseBranch": "main",
-  "updateInternalDependencies": "patch",
-  "ignore": []
+  "updateInternalDependencies": "patch"
 }

.npmrc

@@ -2,4 +2,6 @@
 enable-pre-post-scripts=true
 ignore-workspace-root-check=true 
 hoist-pattern[]=!@types/react
-hoist-pattern[]=!@ts-rest/core
+hoist-pattern[]=!@ts-rest/core
+hoist-pattern[]=!analytics
+hoist-pattern[]=!@analytics/*

CHANGELOG.md

@@ -1,5 +1,24 @@
 # pubpub-client
 
+## 1.1.0
+
+### Minor Changes
+
+- Add ability to authenticate using authorization tokens instead of username/password
+- Update changed types
+
+## 1.0.1
+
+### Patch Changes
+
+- 726f510: Initial Release
+
+## 1.0.2
+
+### Patch Changes
+
+- Improve types for facets and certain CRUD operations, make `pubpub.pub.text.importToPub` work
+
 ## 0.9.0
 
 ### Minor Changes
@@ -71,15 +90,3 @@
 ### Minor Changes
 
 - Add the ability to import and export pubs
-
-## 1.0.1
-
-### Patch Changes
-
-- 726f510: Initial Release
-
-## 1.0.2
-
-### Patch Changes
-
-- Improve types for facets and certain CRUD operations, make `pubpub.pub.text.importToPub` work

development.md

@@ -0,0 +1,54 @@
+# Development
+
+These are internal notes for the development of the project.
+
+## Installation
+
+Install dependencies
+
+```bash
+pnpm i
+```
+
+Setup environment correctly
+
+```bash
+cp .env.example .env
+```
+
+Look in the usual place for the relevant variables.
+
+## Running tests
+
+Before running tests, make sure you load the environment variables from the `.env` file.
+
+```bash
+source .env
+```
+
+> [!NOTE]
+> This is only necessary because I cannot for the life of me find out how to load the environment variables from the `.env` file in the `jest.config.ts` file.
+
+Then, to run the tests, run
+
+```bash
+pnpm test
+```
+
+## Generating updated documentation
+
+To generate the updated documentation, run
+
+```bash
+pnpm generate-docs
+```
+
+## Publishing
+
+Just run
+
+```bash
+pnpm publish
+```
+
+This will create a new release in the `changeset` package.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pubpub/sdk",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Official PubPub API client for Node.js.",
   "type": "module",
   "main": "dist/index.cjs",
@@ -9,7 +9,7 @@
   "scripts": {
     "build": "tsup",
     "postbuild": "attw . -P && size-limit",
-    "lint": "tsc",
+    "lint": "tsc --noEmit",
     "ci": "rm -rf dist && npm run lint && pnpm run test && pnpm run build",
     "prepublish": "pnpm run ci",
     "release": "pnpm run ci && changeset publish",
@@ -48,6 +48,7 @@
     "dist"
   ],
   "dependencies": {
+    "@analytics/core": "^0.12.7",
     "@anatine/zod-openapi": "^2.2.0",
     "@ts-rest/core": "github:pubpub/ts-rest#ts-rest-core-v3.30.52-gitpkg",
     "@types/uuid": "^3.3.0",
@@ -63,8 +64,8 @@
     "zod-to-json-schema": "^3.21.4"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.9.0",
-    "@changesets/cli": "^2.26.0",
+    "@arethetypeswrong/cli": "^0.15.3",
+    "@changesets/cli": "^2.27.3",
     "@commitlint/cli": "^17.0.0",
     "@commitlint/config-conventional": "^17.0.0",
     "@jest/types": "^29.6.3",
@@ -107,7 +108,7 @@
     "tsx": "^3.12.7",
     "typedoc": "^0.25.3",
     "typedoc-plugin-markdown": "4.0.0-next.36",
-    "typescript": "^5.2.2",
+    "typescript": "^5.3.3",
     "unified": "^11.0.4",
     "unist-util-is": "^6.0.0",
     "unist-util-visit": "^5.0.0",