feat: hidden contracts with metadata hidden flag (#80)

ForkbombEu · Mar 7, 2024 · a9e86e3 · a9e86e3
1 parent fa16fc8
commit a9e86e3
Show file tree

Hide file tree

Showing 10 changed files with 78 additions and 1 deletion.
diff --git a/src/index.ts b/src/index.ts
@@ -186,6 +186,8 @@ Dir.ready(async () => {
 const generateRoutes = (app: TemplatedApp) => {
 	Dir.files.forEach(async (endpoints) => {
 		const { contract, path, keys, conf, metadata } = endpoints;
+		if (metadata.hidden) return;
+
 		const LOG = L.getSubLogger({
 			stylePrettyLogs: true,
 			prettyLogTemplate:

diff --git a/src/types.ts b/src/types.ts
@@ -42,6 +42,7 @@ export interface Codec {
 }
 
 export interface Metadata {
+	hidden: boolean;
 	disableGet: boolean;
 	disablePost: boolean;
 

diff --git a/src/utils.ts b/src/utils.ts
@@ -123,6 +123,7 @@ export const newMetadata = (configRaw: JSON): Metadata => {
 		errorContentType: configRaw['error_content_type'] || 'plain/text',
 		examples: configRaw['examples'] || {},
 		tags: configRaw['tags'] || ['📑 Zencodes'],
+		hidden: configRaw['hidden'] || false,
 	};
 };
 

diff --git a/tests/fixtures/broken_contracts/exec.keys.json b/tests/fixtures/broken_contracts/exec.keys.json
@@ -0,0 +1,3 @@
+{
+   "data_1": {}
+}
diff --git a/tests/fixtures/broken_contracts/exec.metadata.json b/tests/fixtures/broken_contracts/exec.metadata.json
@@ -0,0 +1,10 @@
+{
+  "examples": {
+    "did": {
+      "value": {
+            "did_document": {"description": "sandbox_test_from_js_updated"},
+            "id": "did:dyne:sandbox.test:33ZZcaRLvdsvAKTkV8eAHZsvioZSgPcC4ReNXLup7Tj4#ethereum_address"
+      }
+    }
+  }
+}
diff --git a/tests/fixtures/broken_contracts/exec.schema.json b/tests/fixtures/broken_contracts/exec.schema.json
@@ -0,0 +1,23 @@
+{
+    "type": "object",
+    "properties": {
+        "data_1": {
+            "type": "object"
+        },
+        "id": {
+            "type": "string"
+        },
+        "did_document": {
+            "type": "object",
+            "properties":  {
+                "description": {
+                    "type": "string"
+                }
+            }
+        }
+    },
+    "required": [
+        "did_document",
+        "id"
+    ]
+}
diff --git a/tests/fixtures/broken_contracts/exec.zen b/tests/fixtures/broken_contracts/exec.zen
@@ -0,0 +1,3 @@
+Given I send object 'data_1' and send sources 'did_document' and manipulate and merge and output into 'data'
+Given I have a 'string dictionary' named 'data'
+Then print the data
diff --git a/tests/fixtures/meta/hidden.metadata.json b/tests/fixtures/meta/hidden.metadata.json
@@ -0,0 +1,3 @@
+{
+    "hidden": true
+}
diff --git a/tests/fixtures/meta/hidden.zen b/tests/fixtures/meta/hidden.zen
@@ -0,0 +1,2 @@
+Given nothing
+Then print the string 'hidden'
diff --git a/tests/workflow.stepci.yml b/tests/workflow.stepci.yml
@@ -241,4 +241,33 @@ tests:
             status: 201
             json:
               output:
-                - "mimmolo"
+                - "mimmolo"
+
+      - name: HIDDEN POST
+        http:
+          url: http://${{env.host}}/meta/hidden
+          method: POST
+          json: {}
+          check:
+            status: 404
+
+      - name: HIDDEN RAW
+        http:
+          url: http://${{env.host}}/meta/hidden/raw
+          method: GET
+          check:
+            status: 404
+
+      - name: HIDDEN APP
+        http:
+          url: http://${{env.host}}/meta/hidden/app
+          method: GET
+          check:
+            status: 404
+
+      - name: HIDDEN GET
+        http:
+          url: http://${{env.host}}/meta/hidden
+          method: GET
+          check:
+            status: 404