feat(org.id-resolver): added DID resolution response schema ./dist/responseSchema.json

Author: kostysh

packages/resolver/package.json

@@ -13,7 +13,7 @@
   "scripts": {
     "lint": "npx eslint . --ext .ts",
     "lint:fix": "npx eslint . --ext .ts --fix",
-    "build": "rm -rf dist && npx tsc -p tsconfig-build.json",
+    "build": "rm -rf dist && npx tsc -p tsconfig-build.json && npx ts-node ./scripts/responseSchema.ts > ./dist/responseSchema.json",
     "test": "npx hardhat test",
     "test:coverage": "npx nyc --reporter=html --reporter=lcov hardhat test"
   },

packages/resolver/scripts/responseSchema.ts

@@ -0,0 +1,127 @@
+import { org } from '@windingtree/org.json-schema';
+
+const responseSchema = {
+  '$id': 'responseSchema.json',
+  title: 'ORGiD DID Resolution Response',
+  allOf: [
+    {
+        '$ref': '#/definitions/DidResponse'
+    }
+  ],
+  definitions: {
+    DidResponse: {
+      type: 'object',
+      properties: {
+        '@context': {
+          '$ref': '#/definitions/ContextReference'
+        },
+        did: {
+          '$ref': '#/definitions/DIDReference'
+        },
+        didDocument: {
+          '$ref': '#/definitions/OrgJsonReference'
+        },
+        didResolutionMetadata: {
+          '$ref': '#/definitions/DIDResolutionMetadata'
+        },
+        didDocumentMetadata: {
+          '$ref': '#/definitions/DIDDocumentMetadata'
+        }
+      },
+      required: [
+        '@context',
+        'did',
+        'didDocument',
+        'didResolutionMetadata',
+        'didDocumentMetadata'
+      ]
+    },
+    DIDResolutionMetadata: {
+      type: 'object',
+      properties: {
+        contentType: {
+          type: 'string',
+          enum: [
+            'application/did+ld+json'
+          ]
+        },
+        retrieved: {
+          type: 'string',
+          format: 'date-time'
+        },
+        duration: {
+          type: 'number'
+        },
+        resolverVersion: {
+          type: 'string'
+        },
+        error: {
+          type: 'string'
+        }
+      },
+      required: [
+        'contentType',
+        'retrieved',
+        'duration',
+        'resolverVersion'
+      ]
+    },
+    DIDDocumentMetadata: {
+      type: 'object',
+      properties: {
+        created: {
+          type: 'string',
+          format: 'date-time'
+        },
+        updated: {
+          type: 'string',
+          format: 'date-time'
+        },
+        deactivated: {
+          type: 'string',
+          format: 'date-time'
+        },
+        data: {
+          '$ref': '#/definitions/OrgIdData'
+        }
+      }
+    },
+    OrgIdData: {
+      type: 'object',
+      properties: {
+        tokenId: {
+          type: 'string'
+        },
+        orgId: {
+          type: 'string'
+        },
+        owner: {
+          type: 'string'
+        },
+        orgJsonUri: {
+          type: 'string'
+        },
+        delegates: {
+          type: 'array',
+          items: {
+            type: 'string'
+          }
+        },
+        created: {
+          type: 'string'
+        }
+      },
+      required: [
+        'tokenId',
+        'orgId',
+        'owner',
+        'orgJsonUri',
+        'delegates',
+        'created'
+      ]
+    },
+    ...org.definitions
+  }
+};
+
+console.log(JSON.stringify(responseSchema, null, 2));

packages/resolver/tsconfig-build.json

@@ -2,6 +2,7 @@
   "extends": "./tsconfig.json",
   "exclude": [
     "node_modules",
-    "test/**/*"
+    "test/**/*",
+    "scripts"
   ]
 }

packages/resolver/tsconfig.json

@@ -19,7 +19,7 @@
   "include": [
     "src",
     "test"
-  ],
+, "scripts/responseSchema.ts"  ],
   "exclude": [
     "node_modules"
   ]