@atproto/oauth-client-node 0.1.3 → 0.2.0

package/README.md

@@ -22,9 +22,10 @@ needs of your application, and must respect the [ATPROTO].
 The `client_metadata` object will typically be built by the backend at startup.
 
 ```ts
-import { NodeOAuthClientOptions } from '@atproto/oauth-client-node'
+import { NodeOAuthClient, Session } from '@atproto/oauth-client-node'
+import { JoseKey } from '@atproto/jwk-jose'
 
-const client = new NodeOAuthClientOptions({
+const client = new NodeOAuthClient({
   // This object will be used to build the payload of the /client-metadata.json
   // endpoint metadata, exposing the client metadata to the OAuth server.
   clientMetadata: {
@@ -54,16 +55,16 @@ const client = new NodeOAuthClientOptions({
 
   // Interface to store authorization state data (during authorization flows)
   stateStore: {
-    set(key: string, internalState: NodeSavedState): Promise<void> {},
-    get(key: string): Promise<NodeSavedState | undefined> {},
-    del(key: string): Promise<void> {},
+    async set(key: string, internalState: NodeSavedState): Promise<void> {},
+    async get(key: string): Promise<NodeSavedState | undefined> {},
+    async del(key: string): Promise<void> {},
   },
 
   // Interface to store authenticated session data
   sessionStore: {
-    set(sub: string, session: Session): Promise<void> {},
-    get(sub: string): Promise<Session | undefined> {},
-    del(sub: string): Promise<void> {},
+    async set(sub: string, session: Session): Promise<void> {},
+    async get(sub: string): Promise<Session | undefined> {},
+    async del(sub: string): Promise<void> {},
   },
 
   // A lock to prevent concurrent access to the session store. Optional if only one instance is running.
@@ -170,21 +171,21 @@ Instead of hard-coding the client metadata in your app, you can fetch it when
 the app starts:
 
 ```ts
-import { NodeOAuthClientOptions } from '@atproto/oauth-client-node'
+import { NodeOAuthClient } from '@atproto/oauth-client-node'
 
-const client = await NodeOAuthClientOptions.fromClientId({
+const client = await NodeOAuthClient.fromClientId({
   clientId: 'https://my-app.com/client-metadata.json',
 
   stateStore: {
-    set(key: string, internalState: NodeSavedState): Promise<void> {},
-    get(key: string): Promise<NodeSavedState | undefined> {},
-    del(key: string): Promise<void> {},
+    async set(key: string, internalState: NodeSavedState): Promise<void> {},
+    async get(key: string): Promise<NodeSavedState | undefined> {},
+    async del(key: string): Promise<void> {},
   },
 
   sessionStore: {
-    set(sub: string, session: Session): Promise<void> {},
-    get(sub: string): Promise<Session | undefined> {},
-    del(sub: string): Promise<void> {},
+    async set(sub: string, session: Session): Promise<void> {},
+    async get(sub: string): Promise<Session | undefined> {},
+    async del(sub: string): Promise<void> {},
   },
 
   // A lock to prevent concurrent access to the session store. Optional if only one instance is running.

package/dist/node-dpop-store.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toDpopKeyStore = void 0;
+exports.toDpopKeyStore = toDpopKeyStore;
 const jwk_jose_1 = require("@atproto/jwk-jose");
 /**
  * Utility function that allows to simplify the store interface by exposing a
@@ -26,5 +26,4 @@ function toDpopKeyStore(store) {
         clear: store.clear?.bind(store),
     };
 }
-exports.toDpopKeyStore = toDpopKeyStore;
 //# sourceMappingURL=node-dpop-store.js.map

package/dist/node-dpop-store.js.map

@@ -1 +1 @@
-{"version":3,"file":"node-dpop-store.js","sourceRoot":"","sources":["../src/node-dpop-store.ts"],"names":[],"mappings":";;;AAEA,gDAA2C;AAO3C;;;GAGG;AACH,SAAgB,cAAc,CAC5B,KAAwC;IAExC,OAAO;QACL,KAAK,CAAC,GAAG,CAAC,GAAM,EAAE,EAAE,OAAO,EAAE,GAAG,IAAI,EAAK;YACvC,MAAM,OAAO,GAAG,OAAO,CAAC,UAAU,CAAA;YAClC,IAAI,CAAC,OAAO;gBAAE,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;YAE7D,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;QAC5C,CAAC;QAED,KAAK,CAAC,GAAG,CAAC,GAAM;YACd,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YACnC,IAAI,CAAC,MAAM;gBAAE,OAAO,SAAS,CAAA;YAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAA;YACnC,MAAM,OAAO,GAAG,MAAM,kBAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;YAC9C,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAkB,CAAA;QAC7C,CAAC;QAED,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC;QAC1B,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC;KAChC,CAAA;AACH,CAAC;AAvBD,wCAuBC"}
+{"version":3,"file":"node-dpop-store.js","sourceRoot":"","sources":["../src/node-dpop-store.ts"],"names":[],"mappings":";;AAaA,wCAuBC;AAlCD,gDAA2C;AAO3C;;;GAGG;AACH,SAAgB,cAAc,CAC5B,KAAwC;IAExC,OAAO;QACL,KAAK,CAAC,GAAG,CAAC,GAAM,EAAE,EAAE,OAAO,EAAE,GAAG,IAAI,EAAK;YACvC,MAAM,OAAO,GAAG,OAAO,CAAC,UAAU,CAAA;YAClC,IAAI,CAAC,OAAO;gBAAE,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;YAE7D,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;QAC5C,CAAC;QAED,KAAK,CAAC,GAAG,CAAC,GAAM;YACd,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YACnC,IAAI,CAAC,MAAM;gBAAE,OAAO,SAAS,CAAA;YAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAA;YACnC,MAAM,OAAO,GAAG,MAAM,kBAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;YAC9C,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAkB,CAAA;QAC7C,CAAC;QAED,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC;QAC1B,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC;KAChC,CAAA;AACH,CAAC"}

package/dist/node-oauth-client.d.ts

@@ -4,11 +4,11 @@ import { OAuthResponseMode } from '@atproto/oauth-types';
 import { NodeSavedSessionStore, NodeSavedStateStore } from './node-dpop-store.js';
 export type * from './node-dpop-store.js';
 export type { OAuthClientOptions, OAuthResponseMode, RuntimeLock };
-export type NodeOAuthClientOptions = Omit<OAuthClientOptions, 'responseMode' | 'runtimeImplementation' | 'handleResolver' | 'sessionStore' | 'stateStore'> & {
-    fallbackNameservers?: AtprotoHandleResolverNodeOptions['fallbackNameservers'];
-    responseMode?: OAuthResponseMode;
+export type NodeOAuthClientOptions = Omit<OAuthClientOptions, 'responseMode' | 'stateStore' | 'sessionStore' | 'runtimeImplementation' | 'handleResolver'> & {
+    responseMode?: Exclude<OAuthResponseMode, 'fragment'>;
     stateStore: NodeSavedStateStore;
     sessionStore: NodeSavedSessionStore;
+    fallbackNameservers?: AtprotoHandleResolverNodeOptions['fallbackNameservers'];
     requestLock?: RuntimeLock;
 };
 export type NodeOAuthClientFromMetadataOptions = OAuthClientFetchMetadataOptions & Omit<NodeOAuthClientOptions, 'clientMetadata'>;

package/dist/node-oauth-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"node-oauth-client.d.ts","sourceRoot":"","sources":["../src/node-oauth-client.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,gCAAgC,EACjC,MAAM,oCAAoC,CAAA;AAE3C,OAAO,EACL,WAAW,EACX,+BAA+B,EAC/B,kBAAkB,EAClB,WAAW,EACZ,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAExD,OAAO,EACL,qBAAqB,EACrB,mBAAmB,EAEpB,MAAM,sBAAsB,CAAA;AAE7B,mBAAmB,sBAAsB,CAAA;AACzC,YAAY,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,WAAW,EAAE,CAAA;AAElE,MAAM,MAAM,sBAAsB,GAAG,IAAI,CACvC,kBAAkB,EAChB,cAAc,GACd,uBAAuB,GACvB,gBAAgB,GAChB,cAAc,GACd,YAAY,CACf,GAAG;IACF,mBAAmB,CAAC,EAAE,gCAAgC,CAAC,qBAAqB,CAAC,CAAA;IAC7E,YAAY,CAAC,EAAE,iBAAiB,CAAA;IAEhC,UAAU,EAAE,mBAAmB,CAAA;IAC/B,YAAY,EAAE,qBAAqB,CAAA;IACnC,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B,CAAA;AAED,MAAM,MAAM,kCAAkC,GAC5C,+BAA+B,GAC7B,IAAI,CAAC,sBAAsB,EAAE,gBAAgB,CAAC,CAAA;AAElD,qBAAa,eAAgB,SAAQ,WAAW;WACjC,YAAY,CAAC,OAAO,EAAE,kCAAkC;gBAKzD,EACV,KAAK,EACL,YAAsB,EACtB,mBAAmB,EAEnB,UAAU,EACV,YAAY,EACZ,WAAuB,EAEvB,GAAG,OAAO,EACX,EAAE,sBAAsB;CA2B1B"}
+{"version":3,"file":"node-oauth-client.d.ts","sourceRoot":"","sources":["../src/node-oauth-client.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,gCAAgC,EACjC,MAAM,oCAAoC,CAAA;AAE3C,OAAO,EACL,WAAW,EACX,+BAA+B,EAC/B,kBAAkB,EAClB,WAAW,EACZ,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAExD,OAAO,EACL,qBAAqB,EACrB,mBAAmB,EAEpB,MAAM,sBAAsB,CAAA;AAE7B,mBAAmB,sBAAsB,CAAA;AACzC,YAAY,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,WAAW,EAAE,CAAA;AAElE,MAAM,MAAM,sBAAsB,GAAG,IAAI,CACvC,kBAAkB,EAEhB,cAAc,GACd,YAAY,GACZ,cAAc,GAEd,uBAAuB,GACvB,gBAAgB,CACnB,GAAG;IACF,YAAY,CAAC,EAAE,OAAO,CAAC,iBAAiB,EAAE,UAAU,CAAC,CAAA;IAErD,UAAU,EAAE,mBAAmB,CAAA;IAC/B,YAAY,EAAE,qBAAqB,CAAA;IAEnC,mBAAmB,CAAC,EAAE,gCAAgC,CAAC,qBAAqB,CAAC,CAAA;IAC7E,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B,CAAA;AAED,MAAM,MAAM,kCAAkC,GAC5C,+BAA+B,GAC7B,IAAI,CAAC,sBAAsB,EAAE,gBAAgB,CAAC,CAAA;AAElD,qBAAa,eAAgB,SAAQ,WAAW;WACjC,YAAY,CAAC,OAAO,EAAE,kCAAkC;gBAKzD,EACV,KAAK,EACL,YAAsB,EACtB,mBAAmB,EAEnB,UAAU,EACV,YAAY,EACZ,WAAuB,EAEvB,GAAG,OAAO,EACX,EAAE,sBAAsB;CA2B1B"}

package/dist/node-oauth-client.js

@@ -17,6 +17,7 @@ class NodeOAuthClient extends oauth_client_1.OAuthClient {
             console.warn('No lock mechanism provided. Credentials might get revoked.');
         }
         super({
+            ...options,
             fetch,
             responseMode,
             handleResolver: new handle_resolver_node_1.AtprotoHandleResolverNode({
@@ -31,7 +32,6 @@ class NodeOAuthClient extends oauth_client_1.OAuthClient {
             },
             stateStore: (0, node_dpop_store_js_1.toDpopKeyStore)(stateStore),
             sessionStore: (0, node_dpop_store_js_1.toDpopKeyStore)(sessionStore),
-            ...options,
         });
     }
 }

package/dist/node-oauth-client.js.map

@@ -1 +1 @@
-{"version":3,"file":"node-oauth-client.js","sourceRoot":"","sources":["../src/node-oauth-client.ts"],"names":[],"mappings":";;;AAAA,6CAAqD;AAErD,6EAG2C;AAC3C,gDAA2C;AAC3C,wDAK8B;AAG9B,6DAI6B;AAyB7B,MAAa,eAAgB,SAAQ,0BAAW;IAC9C,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,OAA2C;QACnE,MAAM,cAAc,GAAG,MAAM,0BAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;QAC/D,OAAO,IAAI,eAAe,CAAC,EAAE,GAAG,OAAO,EAAE,cAAc,EAAE,CAAC,CAAA;IAC5D,CAAC;IAED,YAAY,EACV,KAAK,EACL,YAAY,GAAG,OAAO,EACtB,mBAAmB,EAEnB,UAAU,EACV,YAAY,EACZ,WAAW,GAAG,SAAS,EAEvB,GAAG,OAAO,EACa;QACvB,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,8DAA8D;YAC9D,OAAO,CAAC,IAAI,CAAC,4DAA4D,CAAC,CAAA;QAC5E,CAAC;QAED,KAAK,CAAC;YACJ,KAAK;YACL,YAAY;YACZ,cAAc,EAAE,IAAI,gDAAyB,CAAC;gBAC5C,KAAK;gBACL,mBAAmB;aACpB,CAAC;YACF,qBAAqB,EAAE;gBACrB,WAAW;gBACX,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,kBAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAC3C,eAAe,EAAE,yBAAW;gBAC5B,MAAM,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,CAC3B,IAAA,wBAAU,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE;aACpD;YAED,UAAU,EAAE,IAAA,mCAAc,EAAC,UAAU,CAAC;YACtC,YAAY,EAAE,IAAA,mCAAc,EAAC,YAAY,CAAC;YAE1C,GAAG,OAAO;SACX,CAAC,CAAA;IACJ,CAAC;CACF;AA3CD,0CA2CC"}
+{"version":3,"file":"node-oauth-client.js","sourceRoot":"","sources":["../src/node-oauth-client.ts"],"names":[],"mappings":";;;AAAA,6CAAqD;AAErD,6EAG2C;AAC3C,gDAA2C;AAC3C,wDAK8B;AAG9B,6DAI6B;AA4B7B,MAAa,eAAgB,SAAQ,0BAAW;IAC9C,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,OAA2C;QACnE,MAAM,cAAc,GAAG,MAAM,0BAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;QAC/D,OAAO,IAAI,eAAe,CAAC,EAAE,GAAG,OAAO,EAAE,cAAc,EAAE,CAAC,CAAA;IAC5D,CAAC;IAED,YAAY,EACV,KAAK,EACL,YAAY,GAAG,OAAO,EACtB,mBAAmB,EAEnB,UAAU,EACV,YAAY,EACZ,WAAW,GAAG,SAAS,EAEvB,GAAG,OAAO,EACa;QACvB,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,8DAA8D;YAC9D,OAAO,CAAC,IAAI,CAAC,4DAA4D,CAAC,CAAA;QAC5E,CAAC;QAED,KAAK,CAAC;YACJ,GAAG,OAAO;YAEV,KAAK;YACL,YAAY;YACZ,cAAc,EAAE,IAAI,gDAAyB,CAAC;gBAC5C,KAAK;gBACL,mBAAmB;aACpB,CAAC;YACF,qBAAqB,EAAE;gBACrB,WAAW;gBACX,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,kBAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAC3C,eAAe,EAAE,yBAAW;gBAC5B,MAAM,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,CAC3B,IAAA,wBAAU,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE;aACpD;YAED,UAAU,EAAE,IAAA,mCAAc,EAAC,UAAU,CAAC;YACtC,YAAY,EAAE,IAAA,mCAAc,EAAC,YAAY,CAAC;SAC3C,CAAC,CAAA;IACJ,CAAC;CACF;AA3CD,0CA2CC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/oauth-client-node",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "license": "MIT",
   "description": "ATPROTO OAuth client for the NodeJS",
   "keywords": [
@@ -28,18 +28,18 @@
     "dist"
   ],
   "dependencies": {
-    "@atproto-labs/did-resolver": "0.1.4",
-    "@atproto-labs/handle-resolver-node": "0.1.5",
-    "@atproto/did": "0.1.2",
-    "@atproto/jwk-jose": "0.1.2",
+    "@atproto-labs/did-resolver": "0.1.5",
+    "@atproto-labs/handle-resolver-node": "0.1.7",
+    "@atproto-labs/simple-store": "0.1.1",
+    "@atproto/did": "0.1.3",
     "@atproto/jwk": "0.1.1",
+    "@atproto/jwk-jose": "0.1.2",
     "@atproto/jwk-webcrypto": "0.1.2",
-    "@atproto/oauth-types": "0.1.5",
-    "@atproto/oauth-client": "0.2.2",
-    "@atproto-labs/simple-store": "0.1.1"
+    "@atproto/oauth-client": "0.3.0",
+    "@atproto/oauth-types": "0.2.0"
   },
   "devDependencies": {
-    "typescript": "^5.3.3"
+    "typescript": "^5.6.3"
   },
   "scripts": {
     "build": "tsc --build tsconfig.build.json"