@sphereon/ssi-sdk.resource-resolver 0.30.2-unstable.18 → 0.30.2-unstable.20

package/README.md

@@ -12,6 +12,78 @@
 
 ---
 
+A Veramo resource resolver plugin. This plugin has the option to cache resources and fetch them from a storage.
+
+## Available functions
+
+- resourceResolve
+- resourceClearAllResources
+- resourceDefaultStoreId
+- resourceDefaultNamespace
+- resourceDefaultTtl
+- 
+## Usage
+
+```typescript
+import { IResourceResolver, ResourceResolver } from '@sphereon/ssi-sdk.resource-resolver'
+import { KeyValueStoreEntity, kvStoreMigrations, KeyValueStore, KeyValueTypeORMStoreAdapter } from '@sphereon/ssi-sdk.kv-store-temp'
+
+const dbConnection = createConnection({
+  type: 'react-native',
+  database: 'app.sqlite',
+  location: 'default',
+  logging: false,
+  synchronize: false,
+  migrationsRun: true,
+  migrations: kvStoreMigrations,
+  entities: [KeyValueStoreEntity],
+})
+
+const agent = createAgent<IResourceResolver>({
+  plugins: [
+    new ResourceResolver({
+      resourceStores: new KeyValueStore({ 
+        store: new KeyValueTypeORMStoreAdapter({ dbConnection })
+      }),
+    }),
+  ],
+})
+```
+
+### Resolve a resource:
+
+```typescript
+const response = await agent.resourceResolve({
+  input: 'https://example.com/example_resource.jpg',
+  resourceType: 'example_type',
+})
+```
+
+### Clear all resources:
+
+```typescript
+const storeId = '3c0e6c59-fe47-433c-a3d2-ad18b9c83517'
+const result = await agent.resourceClearAllResources({ storeId })
+```
+
+### Get default store id:
+
+```typescript
+const result = await agent.resourceDefaultStoreId()
+```
+
+### Get default namespace:
+
+```typescript
+const result = await agent.resourceDefaultNamespace()
+```
+
+### Get default ttl:
+
+```typescript
+const result = await agent.resourceDefaultTtl()
+```
+
 ## Installation
 
 ```shell

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sphereon/ssi-sdk.resource-resolver",
-  "version": "0.30.2-unstable.18+0b3c5f50",
+  "version": "0.30.2-unstable.20+61a818af",
   "source": "src/index.ts",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -14,14 +14,14 @@
     "build:clean": "tsc --build --clean && tsc --build"
   },
   "dependencies": {
-    "@sphereon/ssi-sdk.kv-store-temp": "0.30.2-unstable.18+0b3c5f50",
+    "@sphereon/ssi-sdk.kv-store-temp": "0.30.2-unstable.20+61a818af",
     "cross-fetch": "^3.1.8",
     "debug": "^4.3.5",
     "typeorm": "^0.3.20",
     "uint8arrays": "^3.1.1"
   },
   "devDependencies": {
-    "@sphereon/ssi-sdk.agent-config": "0.30.2-unstable.18+0b3c5f50",
+    "@sphereon/ssi-sdk.agent-config": "0.30.2-unstable.20+61a818af",
     "@veramo/remote-client": "4.2.0",
     "@veramo/remote-server": "4.2.0",
     "nock": "^13.5.4",
@@ -48,5 +48,5 @@
     "Resource Management",
     "Caching"
   ],
-  "gitHead": "0b3c5f5070c407f7b388a35e7959f58a51f527c6"
+  "gitHead": "61a818aff2848c41bdb7a9a8c9160b5d66c74e75"
 }