Merge branch 'main' of https://github.com/terminusdb/terminusdb-client-js

Author: Kitty Jose

.babelrc

@@ -1,5 +1,6 @@
 {
-  "presets": ["@babel/preset-env"],
-  "plugins": ["@babel/plugin-transform-regenerator",
-    "@babel/plugin-transform-runtime"]
+  "sourceType": "unambiguous",
+  "presets": [
+    ["@babel/preset-env", {"corejs": "3.25", "useBuiltIns": "entry"}]
+  ]
 }

.eslintignore

@@ -8,3 +8,4 @@ package-lock.json
 .nyc_output
 test/
 tutorial/
+local_test/

.github/workflows/docs.yml

@@ -21,9 +21,9 @@ jobs:
       with:
         source_folder: 'docs/api/.'
         destination_repo: 'terminusdb/terminusdb-docs'
-        destination_folder: 'index/terminusx-db/reference-guides/javascript-client-reference'
+        destination_folder: 'guides/reference-guides/javascript-client-reference'
         destination_base_branch: 'main'
         destination_head_branch: ${{ env.BRANCH_NAME }}
         user_email: 'neel@terminusdb.com'
         user_name: 'Neelterminusdb'
-        pull_request_reviewers: 'mark-terminusdb'
+        pull_request_reviewers: 'mark-terminusdb'

README.md

@@ -22,9 +22,7 @@ graph all through a simple document API.
 [terminusdb-docs]: https://terminusdb.com/docs/
 [terminusdb-repo]: https://github.com/terminusdb/terminusdb
 
-**TerminusX** is a self-service data platform that allows you to build, deploy,
-execute, monitor, and share versioned data products. It is built on TerminusDB.
-TerminusX is in public beta and you can [sign up now][dashboard].
+**TerminusX** TerminusX is TerminusDB as a service. SOC 2 certified hosting. Build your beta and get to market fast. Scale up and deploy your own instance. [Sign up now][dashboard].
 
 [dashboard]: https://dashboard.terminusdb.com/
 
@@ -71,7 +69,7 @@ it to your sources, and use that in the `<script>` instead.
 This example creates a simple dataProduct, starting to create a database model the schema
 and insert a simple document
 
-For the [full Documentation][terminusdb-client-js-docs]
+For the [full Documentation](https://terminusdb.com/docs/guides/reference-guides/javascript-client-reference)
 
 ```javascript
 const TerminusClient = require("@terminusdb/terminusdb-client");
@@ -100,7 +98,7 @@ const bankerSchema = [
       "@type":"Class",
       "@id":"Person",
       "@key":{
-         "@type":"Hash",
+         "@type":"Lexical",
          "@fields":[
             "name"
          ]

RELEASE_NOTES.md

@@ -1,3 +1,18 @@
+# TerminusDB Client v10.0.19
+
+## New 🚀
+
+* Add getOrganization in AccessControl class
+* Add hasDatabase head api call in WOQL-Client
+* Add Woql.Vars in WOQL class
+
+## Fixes 🛠
+
+* Remove core-js@2
+* Documentation fixes
+* Fix update_triple in woql
+* Fix types declaration
+
 # TerminusDB Client v10.0.12
 
 ## New 🚀

docs/README.md

@@ -100,7 +100,7 @@ const bankerSchema = [
       "@type":"Class",
       "@id":"Person",
       "@key":{
-         "@type":"Hash",
+         "@type":"Lexical",
          "@fields":[
             "name"
          ]

docs/_sidebar.md

@@ -60,9 +60,10 @@
     - [getPrefixes](api/woqlClient.js?id=getPrefixes)
     - [getUserOrganizations](api/woqlClient.js?id=getUserOrganizations)
     - [userOrganizations](api/woqlClient.js?id=userOrganizations)
-    - [getDiff](api/woqlClient.js?id=getDiff)
+    - [getJSONDiff](api/woqlClient.js?id=getJSONDiff)
     - [getVersionObjectDiff](api/woqlClient.js?id=getVersionObjectDiff)
     - [getVersionDiff](api/woqlClient.js?id=getVersionDiff)
+    - [apply](api/woqlClient.js?id=apply)
     - [patch](api/woqlClient.js?id=patch)
 - [WOQL](api/woql.js?id=WOQL)
   - [using](api/woql.js?id=using)
@@ -169,6 +170,7 @@
   - [setApiToken](api/accessControl.js?id=setApiToken)
   - [setApiKey](api/accessControl.js?id=setApiKey)
   - [getAPIUrl](api/accessControl.js?id=getAPIUrl)
+  - [customHeaders](api/accessControl.js?id=customHeaders)
   - [getAllOrganizations](api/accessControl.js?id=getAllOrganizations)
   - [createOrganization](api/accessControl.js?id=createOrganization)
   - [deleteOrganization](api/accessControl.js?id=deleteOrganization)

docs/api/accesscontrol.md

@@ -104,6 +104,18 @@ add extra headers to your request
 | customHeaders | <code>object</code> | 
 
 
+## getOrganization
+##### accessControl.getOrganization(organization) ⇒ <code>object</code>
+-- TerminusDB API ---
+Get an organization from the TerminusDB API.
+
+**Returns**: <code>object</code> - - organization  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| organization | <code>string</code> | The organization |
+
+
 ## getAllOrganizations
 ##### accessControl.getAllOrganizations() ⇒ <code>Promise</code>
 -- TerminusDB API ---
@@ -242,25 +254,33 @@ accessControl.deleteUser(userId).then(result=>{
 ```
 
 ## manageCapability
-##### accessControl.manageCapability(userId, resourceId, rolesArr, operation) ⇒ <code>Promise</code>
+##### accessControl.manageCapability(userName, resourceName, rolesArr, operation, resourceType) ⇒ <code>Promise</code>
 -- TerminusdDB API ---
 Grant/Revoke Capability
 
 **Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| userId | <code>string</code> | the document user id |
-| resourceId | <code>string</code> | the resource id (database or team) |
-| rolesArr | <code>array</code> | the roles list |
+| userName | <code>string</code> | the document user id |
+| resourceName | <code>string</code> | the name of a (database or team) |
+| rolesArr | <code>array</code> | the roles name list |
 | operation | <code>typedef.CapabilityCommand</code> | grant/revoke operation |
+| resourceType | <code>typedef.ResourceType</code> | the resource type (database or organization) |
 
 **Example**  
 ```javascript
-{ "operation" : "grant",
-  "scope" : "Organization/myteam",
-  "user" : "User/myUser",
-  "roles" : ["Role/reader"] }
+//we add an user to an organization and manage users' access
+//the user myUser can  access the Organization and all the database under the organization with "reader" Role
+client.manageCapability(myUser,myteam,[reader],"grant","organization").then(result=>{
+ consol.log(result)
+})
+
+//the user myUser can  access the database db__001 under the organization myteam
+//with "writer" Role
+client.manageCapability(myUser,myteam/db__001,[writer],"grant","database").then(result=>{
+ consol.log(result)
+})
 ```
 
 ## getAccessRoles

docs/api/typedef.md

@@ -32,6 +32,7 @@ the POST document interface query parameters
 
 | Name | Type | Description |
 | --- | --- | --- |
+| [raw_json] | <code>boolean</code> | default is false, If true, the input documents  are treated as raw JSON, inserted as type sys:JSONDocument and are not subject  to schema restrictions. |
 | [graph_type] | <code>GraphType</code> | default is instance  instance|schema Used to switch between  getting documents from the instance or the schema graph. |
 | [full_replace] | <code>boolean</code> | default is false, If true, all existing documents are deleted  before inserting the posted documents. This allows the full replacement of the contents of a  database. This is especially useful for replacing the schema. |
 
@@ -44,6 +45,7 @@ the PUT document interface query parameters
 
 | Name | Type | Description |
 | --- | --- | --- |
+| [raw_json] | <code>boolean</code> | default is false, If true, the input documents  are treated as raw JSON, inserted as type sys:JSONDocument and are not subject  to schema restrictions. |
 | [graph_type] | <code>GraphType</code> | default is instance, instance|schema Used to switch between  getting documents from the instance or the schema graph. |
 
 
@@ -90,7 +92,7 @@ the DELETE document interface query parameters
 
 | Name | Type | Description |
 | --- | --- | --- |
-| type | <code>&#x27;basic&#x27;</code> \| <code>&#x27;jwt&#x27;</code> | the authorization type of an TerminusDB connection |
+| type | <code>&#x27;basic&#x27;</code> \| <code>&#x27;jwt&#x27;</code> \| <code>&#x27;apikey&#x27;</code> | the authorization type of an TerminusDB connection |
 | [user] | <code>string</code> \| <code>boolean</code> | the user id | I don't need the user with the jwt token |
 | key | <code>string</code> | the connection key |
 
@@ -129,6 +131,9 @@ the DELETE document interface query parameters
 | [invitation] | <code>string</code> | - |
 
 
+## ResourceType
+##### ResourceType:  `  "database"` |  `  "organization" ` 
+
 ## RepoType
 ##### RepoType:  `  "local"` |  `  "remote" ` 
 
@@ -138,13 +143,9 @@ the DELETE document interface query parameters
 
 | Name | Type | Description |
 | --- | --- | --- |
-| [organization] | <code>string</code> | the db organization id |
-| id | <code>string</code> | The database identification name |
 | label | <code>string</code> | "Textual DB Name" |
 | [comment] | <code>string</code> | "Text description of DB" |
 | [public] | <code>boolean</code> |  |
-| [icon] | <code>string</code> | The database's icon |
-| [prefixes] | <code>object</code> | {scm: "http://url.to.use/for/scm", doc: "http://url.to.use/for/doc"} |
 | [schema] | <code>boolean</code> | if set to true, a schema graph will be created |
 
 

docs/api/woql.md

@@ -387,22 +387,6 @@ Identifies a remote resource by URL and specifies the format of the resource thr
 remote({url:"http://url.of.resource"}, {type: "csv"})
 ```
 
-## file
-##### WOQL.file(url, [formatObj]) ⇒ <code>WOQLQuery</code>
-Identifies a file resource as a path on the server and specifies the format through the options
-
-**Returns**: <code>WOQLQuery</code> - A WOQLQuery which contains the file resource identifier  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| url | <code>object</code> | The Path on the server at which the file resource can be accessed |
-| [formatObj] | <code>typedef.DataFormatObj</code> | imput options |
-
-**Example**  
-```javascript
-file("/path/to/file", {type: 'turtle'} )
-```
-
 ## post
 ##### WOQL.post(url, [formatObj], [source]) ⇒ <code>WOQLQuery</code>
 Identifies a resource as a local path on the client, to be sent to the server through a
@@ -1429,6 +1413,20 @@ Gets/Sets woqlClient
 | client | <code>WOQLClient</code> | 
 
 
+## Vars
+##### WOQL.Vars(...varNames) ⇒
+**Returns**: object  
+
+| Param | Type |
+| --- | --- |
+| ...varNames | <code>string</code> | 
+
+**Example**  
+```javascript
+const v = WOQL.Vars('var01', 'var02', 'var03');
+triple(v.var01, v.var02, v.var03)
+```
+
 ## emerge
 ##### WOQL.emerge(auto_eval)
 query module