feat: Generating plugin schema

decentralized-identity · Nov 23, 2020 · dc80083 · dc80083
1 parent bf1466b
commit dc80083
Show file tree

Hide file tree

Showing 42 changed files with 3,812 additions and 3,936 deletions.
diff --git a/package.json b/package.json
@@ -2,11 +2,11 @@
   "name": "daf",
   "private": true,
   "scripts": {
-    "build": "yarn lerna run build && yarn extract-api && yarn create-plugin-credential && yarn docs:api && yarn docs:examples && yarn docs:clean-temp && yarn prettier:examples",
+    "build": "yarn lerna run build && yarn extract-api && yarn generate-plugin-schema && yarn docs:api && yarn docs:examples && yarn docs:clean-temp && yarn prettier:examples",
     "publish": "lerna publish",
     "bootstrap": "lerna bootstrap",
     "extract-api": "lerna run extract-api",
-    "create-plugin-credential": "lerna run create-plugin-credential",
+    "generate-plugin-schema": "lerna run generate-plugin-schema",
     "docs:examples": "ts-node --project packages/tsconfig.settings.json ./scripts/extract-examples.ts",
     "docs:api": "ts-node ./scripts/generate-docs.ts",
     "docs:reference": "api-documenter markdown -i ./temp -o ./docs/api",

diff --git a/packages/daf-cli/src/schema.ts b/packages/daf-cli/src/schema.ts
@@ -84,19 +84,16 @@ function getReference(response: string): OpenAPIV3.ReferenceObject | OpenAPIV3.S
 }
 
 program
-  .command('create-plugin-credential')
-  .description('Create plugin credential')
+  .command('generate-plugin-schema')
+  .description('Generate plugin schema')
   .option('-c, --extractorConfig <string>', 'API Extractor config file', './api-extractor.json')
   .option(
     '-p, --packageConfig <string>',
     'package.json file containing DAF plugin interface config',
     './package.json',
   )
-  .option('-i, --issuer <string>', 'Schema credential issuer')
 
   .action(async (options) => {
-    const agent = getAgent(program.config)
-
     const apiExtractorJsonPath: string = resolve(options.extractorConfig)
     const extractorConfig: ExtractorConfig = ExtractorConfig.loadFileAndPrepare(apiExtractorJsonPath)
 
@@ -114,9 +111,7 @@ program
     }
 
     const packageConfig = require(resolve(options.packageConfig))
-    const credentialSubject: any = {
-      interfaces: {},
-    }
+    const interfaces: any = {}
 
     for (const pluginInterfaceName in packageConfig.daf.pluginInterfaces) {
       const entryFile = packageConfig.daf.pluginInterfaces[pluginInterfaceName]
@@ -182,34 +177,10 @@ program
         }
       }
 
-      credentialSubject.interfaces[pluginInterfaceName] = api
-    }
-
-    let issuer: IIdentity
-    if (options.did) {
-      issuer = await agent.identityManagerGetIdentity({ did: options.did })
-      if (!issuer) {
-        throw Error('DID not found ' + options.did)
-      }
-    } else {
-      issuer = await agent.identityManagerGetOrCreateIdentity({
-        alias: 'default',
-      })
+      interfaces[pluginInterfaceName] = api
     }
 
-    const verifiableCredential = await agent.createVerifiableCredential({
-      credential: {
-        issuer: { id: issuer.did },
-        '@context': ['https://www.w3.org/2018/credentials/v1'],
-        type: ['VerifiableCredential', 'AgentPluginSchema'],
-        issuanceDate: new Date().toISOString(),
-        credentialSubject,
-      },
-      proofFormat: 'jwt',
-      save: true,
-    })
-
-    writeFileSync(resolve('./plugin.credential.json'), JSON.stringify(verifiableCredential, null, 2))
+    writeFileSync(resolve('./plugin.schema.json'), JSON.stringify(interfaces, null, 2))
   })
 
 program

diff --git a/packages/daf-core/api/daf-core.api.json b/packages/daf-core/api/daf-core.api.json
@@ -5862,27 +5862,6 @@
           ],
           "extendsTokenRanges": []
         },
-        {
-          "kind": "Variable",
-          "canonicalReference": "daf-core!pluginCredential:var",
-          "docComment": "",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "pluginCredential: "
-            },
-            {
-              "kind": "Content",
-              "text": "any"
-            }
-          ],
-          "releaseTag": "Public",
-          "name": "pluginCredential",
-          "variableTypeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 2
-          }
-        },
         {
           "kind": "Interface",
           "canonicalReference": "daf-core!RemoveContext:interface",
@@ -6014,6 +5993,27 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "daf-core!schema:var",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "schema: "
+            },
+            {
+              "kind": "Content",
+              "text": "any"
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "schema",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "daf-core!TAgent:type",

diff --git a/packages/daf-core/api/daf-core.api.md b/packages/daf-core/api/daf-core.api.md
@@ -352,9 +352,6 @@ export interface IService {
     type: string;
 }
 
-// @public (undocumented)
-export const pluginCredential: any;
-
 // @public
 export interface RemoveContext<T extends IPluginMethod> {
     // (undocumented)
@@ -366,6 +363,9 @@ export interface ResolveDidArgs {
     didUrl: string;
 }
 
+// @public (undocumented)
+export const schema: any;
+
 // @public
 export type TAgent<T extends IPluginMethodMap> = {
     [P in keyof T]: RemoveContext<T[P]>;

diff --git a/packages/daf-core/package.json b/packages/daf-core/package.json
@@ -6,7 +6,7 @@
   "types": "build/index.d.ts",
   "scripts": {
     "build": "tsc",
-    "create-plugin-credential": "yarn daf create-plugin-credential --config=../../agent.yml"
+    "generate-plugin-schema": "yarn daf generate-plugin-schema"
   },
   "daf": {
     "pluginInterfaces": {
@@ -31,7 +31,7 @@
   "files": [
     "build/**/*",
     "src/**/*",
-    "plugin.credential.json",
+    "plugin.schema.json",
     "README.md",
     "LICENSE"
   ],