@atproto/identity 0.1.0 → 0.2.1

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# @atproto/identity
+
+## 0.2.1
+
+### Patch Changes
+
+- Updated dependencies [[`41ee177f`](https://github.com/bluesky-social/atproto/commit/41ee177f5a440490280d17acd8a89bcddaffb23b)]:
+  - @atproto/common-web@0.2.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-2023 Bluesky PBC
+
+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.

package/README.md

@@ -1,3 +1,40 @@
-# ATP DID Resolver
+# @atproto/identity
 
-A library for resolving ATP's Decentralized ID methods.
+TypeScript library for decentralized identities in [atproto](https://atproto.com) using DIDs and handles
+
+[![NPM](https://img.shields.io/npm/v/@atproto/identity)](https://www.npmjs.com/package/@atproto/identity)
+[![Github CI Status](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml/badge.svg)](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml)
+
+## Example
+
+Resolving a Handle and verifying against DID document:
+
+```typescript
+const didres = new DidResolver({})
+const hdlres = new HandleResolver({})
+
+const handle = 'atproto.com'
+const did = await hdlres.resolve(handle)
+
+if (did == undefined) {
+  throw new Error('expected handle to resolve')
+}
+console.log(did) // did:plc:ewvi7nxzyoun6zhxrhs64oiz
+
+const doc = await didres.resolve(did)
+console.log(doc)
+
+// additional resolutions of same DID will be cached for some time, unless forceRefresh flag is used
+const doc2 = await didres.resolve(did, true)
+
+// helper methods use the same cache
+const data = await didres.resolveAtprotoData(did)
+
+if (data.handle != handle) {
+  throw new Error('invalid handle (did not match DID document)')
+}
+```
+
+## License
+
+MIT License

package/build.js

@@ -1,16 +1,8 @@
-const pkgJson = require('@npmcli/package-json')
 const { nodeExternalsPlugin } = require('esbuild-node-externals')
 
 const buildShallow =
   process.argv.includes('--shallow') || process.env.ATP_BUILD_SHALLOW === 'true'
 
-if (process.argv.includes('--update-main-to-dist')) {
-  return pkgJson
-    .load(__dirname)
-    .then((pkg) => pkg.update({ main: 'dist/index.js' }))
-    .then((pkg) => pkg.save())
-}
-
 require('esbuild').build({
   logLevel: 'info',
   entryPoints: ['src/index.ts'],

package/dist/did/atproto-data.d.ts

@@ -4,5 +4,6 @@ export declare const getKey: (doc: DidDocument) => string | undefined;
 export declare const getHandle: (doc: DidDocument) => string | undefined;
 export declare const getPds: (doc: DidDocument) => string | undefined;
 export declare const getFeedGen: (doc: DidDocument) => string | undefined;
+export declare const getNotif: (doc: DidDocument) => string | undefined;
 export declare const parseToAtprotoDocument: (doc: DidDocument) => Partial<AtprotoData>;
 export declare const ensureAtpDocument: (doc: DidDocument) => AtprotoData;