Merge pull request #465 from Permify/next

Next

Author: tolgaozen

docs/documentation/docs/getting-started/examples/facebook-groups.md

@@ -513,9 +513,18 @@ relationships:
     - event:1#owner@user:3
     - event:1#group@group:1
 
-assertions:
-    - "can user:4 RSVP_to_event event:1": false
-    - "can user:5 view_comment comment:1": true
+scenarios:
+  - name: "scenario 1"
+    description: "test description"
+    checks:
+      - entity: "event:1"
+        subject: "user:4"
+        assertions:
+          RSVP_to_event : false
+      - entity: "comment:1"
+        subject: "user:5"
+        assertions:
+          view_comment : true
 ```
 
 ### Using Schema Validator in Local

docs/documentation/docs/getting-started/examples/google-docs.md

@@ -279,10 +279,22 @@ relationships:
     - resource:hr_documents#manager@group:hr#manager
     - resource:hr_documents#viewer@group:hr#member
 
-assertions:
-    - "can user:ashley edit resource:product_database": true
-    - "can user:joe view resource:hr_documents": true
-    - "can user:david view resource:marketing_materials": false
+scenarios:
+  - name: "scenario 1"
+    description: "test description"
+    checks:
+      - entity: "resource:product_database"
+        subject: "user:ashley"
+        assertions:
+          edit : true
+      - entity: "resource:hr_documents"
+        subject: "user:joe"
+        assertions:
+          view : true
+      - entity: "resource:marketing_materials"
+        subject: "user:david"
+        assertions:
+          view : false
 ```
 
 ### Using Schema Validator in Local 

docs/documentation/docs/getting-started/examples/notion.md

@@ -515,9 +515,18 @@ relationships:
     - comment:task_list_2_comment_2#block@block:task_list_2
     - comment:task_list_2_comment_2#author@user:charlie
 
-assertions:
-    - "can user:alice write database:task_list": true
-    - "user:charlie write page:product_spec": false
+scenarios:
+  - name: "scenario 1"
+    description: "test description"
+    checks:
+      - entity: "database:task_list"
+        subject: "user:alice"
+        assertions:
+          write : true
+      - entity: "page:product_spec"
+        subject: "user:charlie"
+        assertions:
+          write : false
 ```
 
 ### Using Schema Validator in Local

docs/documentation/docs/getting-started/testing.md

@@ -78,13 +78,45 @@ relationships:
     - "organization:1#member@user:43"
     - "repository:1#owner@user:43"
 
-assertions:
-    - "can user:1 push repository:1": true
-    - "can user:1 push repository:2": false
-    - "can user:1 push repository:3": false
-    - "can user:43 edit repository:1": false
+scenarios:
+  - name: "scenario 1"
+    description: "test description"
+    checks:
+      - entity: "repository:1"
+        subject: "user:1"
+        assertions:
+          push : true
+          owner : true
+      - entity: "repository:2"
+        subject: "user:1"
+        assertions:
+          push : false
+      - entity: "repository:3"
+        subject: "user:1"
+        assertions:
+          push : false
+      - entity: "repository:1"
+        subject: "user:43"
+        assertions:
+          edit : false
+    entity_filters:
+      - entity_type: "repository"
+        subject: "user:1"
+        assertions:
+          push : ["1"]
+          edit : []
+
 ```
 
+## Coverage Analysis
+
+By using the command `permify coverage {path of your schema validation file}`, you can measure the coverage for your schema. 
+The coverage is calculated by analyzing the relationships and assertions in your created model, identifying any missing elements. 
+The output of the example provided above is as follows.
+
+![schema-coverage](https://user-images.githubusercontent.com/39353278/236303688-15cc2673-05e6-42d3-9ad4-0c538f546fb0.png)
+
+
 ## Testing in Local
 
 You can also test your new authorization model in your local (Permify clone) without using [permify-validate-action] at all. 
@@ -93,7 +125,7 @@ For that open up a new file and add a schema yaml file inside. Then build your p
 
 If we use the above example schema validation file, after running `./permify validate {path of your schema validation file}` it gives a result on the terminal as:
 
-![schema-validation](https://user-images.githubusercontent.com/34595361/207110538-9837b09d-26b4-409a-a309-a21f66e6677a.png)
+![schema-validation](https://user-images.githubusercontent.com/39353278/236303542-930de83f-ebdd-4b0a-a09e-5c069744cc5c.png)
 
 [permify-validate-action]: https://github.com/Permify/permify-validate-action
 

docs/documentation/package.json

@@ -16,11 +16,11 @@
   },
   "dependencies": {
     "@cmfcmf/docusaurus-search-local": "^1.1.0",
-    "@docusaurus/core": "^2.0.0-beta.17",
-    "@docusaurus/plugin-client-redirects": "^2.3.1",
-    "@docusaurus/plugin-google-analytics": "^2.0.0-beta.17",
-    "@docusaurus/plugin-google-gtag": "^2.0.0-beta.17",
-    "@docusaurus/preset-classic": "^2.3.1",
+    "@docusaurus/core": "^2.4.0",
+    "@docusaurus/plugin-client-redirects": "^2.4.0",
+    "@docusaurus/plugin-google-analytics": "^2.4.0",
+    "@docusaurus/plugin-google-gtag": "^2.4.0",
+    "@docusaurus/preset-classic": "^2.4.0",
     "@glidejs/glide": "^3.6.0",
     "@reach/accordion": "^0.18.0",
     "@redq/reuse-modal": "^2.0.0",
@@ -72,7 +72,7 @@
     "swiper": "^9.1.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "^2.3.1",
+    "@docusaurus/module-type-aliases": "^2.4.0",
     "@tsconfig/docusaurus": "^1.0.4",
     "typescript": "^4.9.5"
   },

docs/documentation/src/theme/prism-perm-lang.js

@@ -1,6 +1,10 @@
 (function (Prism) {
     Prism.languages.perm = Prism.languages.extend('clike', {
         'class-name': [
+            {
+                pattern: /\\B@\\w+#?\\w+/,
+                lookbehind: true
+            },
             {
                 pattern: /(\b(?:entity)\s+)(\w+\/)?\w*(?=\s*\{)/,
                 lookbehind: true
@@ -9,6 +13,10 @@
                 pattern: /(\b(?:action)\s+)\w+(?=\s*\=)/,
                 lookbehind: true
             },
+            {
+                pattern: /(\b(?:permission)\s+)\w+(?=\s*\=)/,
+                lookbehind: true
+            },
             {
                 pattern: /(\b(?:relation)\s+)\w+(?=\s*\:)/,
                 lookbehind: true
@@ -26,6 +34,6 @@
                 lookbehind: true
             },
         ],
-        'keyword': /\b(?:entity|relation|action|or|not|and)\b(?!\s*=\s*\d)/,
+        'keyword': /\b(?:entity|permission|relation|action|or|not|and)\b(?!\s*=\s*\d)/,
     });
 }(Prism));