Merge pull request #360 from terminusdb/add-prefix-management

Add prefix management

Author: hoijnet

lib/connectionConfig.js

@@ -741,6 +741,13 @@ ConnectionConfig.prototype.prefixesURL = function () {
   return this.branchBase('prefixes');
 };
 
+ConnectionConfig.prototype.prefixURL = function () {
+  if (this.db() === this.system_db) {
+    return this.dbBase('prefix');
+  }
+  return this.branchBase('prefix');
+};
+
 ConnectionConfig.prototype.queryParameter = function (params) {
   if (!params || typeof params !== 'object') return '';
   const queryString = Object.keys(params).map((key) => `${key}=${encodeURISegment(params[key])}`).join('&');

lib/query/woqlCore.js

@@ -20,7 +20,18 @@ const { Var, Vars, Doc } = require('./woqlDoc');
 const typedef = require('../typedef');
 
 /**
- * @typedef {import('../typedef').WOQLJson} WOQLJson
+ * @typedef {Object} WOQLJson - JSON-LD representation of a WOQL query
+ * @property {string} @type - The WOQL operation type
+ * @property {*} [subject] - Subject for triple patterns
+ * @property {*} [predicate] - Predicate for triple patterns
+ * @property {*} [object] - Object for triple patterns
+ * @property {WOQLJson[]} [and] - Array of queries for 'And' operations
+ * @property {WOQLJson[]} [or] - Array of queries for 'Or' operations
+ * @property {WOQLJson} [query] - Nested query
+ * @property {string[]} [variables] - Variable list for 'Select' operations
+ * @property {string} [graph] - Graph identifier
+ * @property {*} [consequent] - Consequent for path queries
+ * @property {string} [path_pattern] - Pattern for path queries
  */
 
 /**
@@ -414,12 +425,11 @@ WOQLQuery.prototype.cleanObject = function (o, t) {
     }
     obj.list = res;
   } else if (typeof o === 'object' && o) {
-    if (typeof o['@value'] !== 'undefined') obj.data = o;
-    else return o;
-  // eslint-disable-next-line no-dupe-else-if
-  } else if (typeof o === 'boolean') {
-    t = t || 'xsd:boolean';
-    obj['woql:datatype'] = this.jlt(o, t);
+    if (typeof o['@value'] !== 'undefined') {
+      obj.data = o;
+    } else {
+      return o;
+    }
   }
   return obj;
 };
@@ -428,9 +438,11 @@ WOQLQuery.prototype.cleanDataValue = function (o, t) {
   const obj = { '@type': 'DataValue' };
   if (o instanceof Var) {
     return this.expandDataVariable(o);
-  } if (o instanceof Doc) {
+  }
+  if (o instanceof Doc) {
     return o.encoded;
-  } if (typeof o === 'string') {
+  }
+  if (typeof o === 'string') {
     if (o.indexOf('v:') !== -1) {
       return this.expandDataVariable(o);
     }

lib/query/woqlLibrary.js

@@ -3,7 +3,80 @@
 const WOQLQuery = require('./woqlBuilder');
 
 /**
- * @typedef {import('./woqlBuilder')} WOQLQuery
+ * @typedef {Object} WOQLQuery - WOQL Query Builder class
+ * @property {function} triple - Add a triple pattern
+ * @property {function} and - Logical AND
+ * @property {function} or - Logical OR
+ * @property {function} select - Select variables
+ * @property {function} ask - Ask query
+ * @property {function} limit - Limit results
+ * @property {function} offset - Offset results
+ * @property {function} start - Start query
+ * @property {function} path - Path query
+ * @property {function} subquery - Subquery
+ * @property {function} from - Graph specifier
+ * @property {function} eq - Equality
+ * @property {function} not - Negation
+ * @property {function} greaterThan - Greater than
+ * @property {function} lessThan - Less than
+ * @property {function} greaterThanOrEqual - Greater than or equal
+ * @property {function} lessThanOrEqual - Less than or equal
+ * @property {function} like - String pattern matching
+ * @property {function} plus - Addition
+ * @property {function} minus - Subtraction
+ * @property {function} times - Multiplication
+ * @property {function} divide - Division
+ * @property {function} count - Count aggregation
+ * @property {function} sum - Sum aggregation
+ * @property {function} min - Minimum aggregation
+ * @property {function} max - Maximum aggregation
+ * @property {function} avg - Average aggregation
+ * @property {function} groupBy - Group by
+ * @property {function} orderBy - Order by
+ * @property {function} asc - Ascending order
+ * @property {function} desc - Descending order
+ * @property {function} json - JSON object
+ * @property {function} id - IRI
+ * @property {function} string - String literal
+ * @property {function} datetime - DateTime literal
+ * @property {function} date - Date literal
+ * @property {function} time - Time literal
+ * @property {function} boolean - Boolean literal
+ * @property {function} integer - Integer literal
+ * @property {function} decimal - Decimal literal
+ * @property {function} double - Double literal
+ * @property {function} value - Value literal
+ * @property {function} var - Variable
+ * @property {function} v - Variable shorthand
+ * @property {function} doc - Document
+ * @property {function} class - Class
+ * @property {function} property - Property
+ * @property {function} comment - Comment
+ * @property {function} label - Label
+ * @property {function} prefix - Prefix
+ * @property {function} using - Using
+ * @property {function} optional - Optional
+ * @property {function} union - Union
+ * @property {function} filter - Filter
+ * @property {function} bind - Bind
+ * @property {function} exists - Exists
+ * @property {function} notExists - Not exists
+ * @property {function} graph - Graph
+ * @property {function} named - Named graph
+ * @property {function} values - Values
+ * @property {function} minus - Minus
+ * @property {function} service - Service
+ * @property {function} load - Load
+ * @property {function} clear - Clear
+ * @property {function} drop - Drop
+ * @property {function} add - Add
+ * @property {function} move - Move
+ * @property {function} copy - Copy
+ * @property {function} insert - Insert
+ * @property {function} delete - Delete
+ * @property {function} modify - Modify
+ * @property {function} construct - Construct
+ * @property {function} describe - Describe
  */
 
 /**

lib/query/woqlQuery.js

@@ -336,7 +336,7 @@ WOQLQuery.prototype.select = function (...varNames) {
  * Parameters with null values are local-only variables.
  *
  * @param {object} paramSpec - Object mapping parameter names to values (or null for local vars)
- * @returns {[function, object]} Tuple of [localized function, variables object]
+ * @returns {LocalizeResult} Tuple of [localized function, variables object]
  * @example
  * const [localized, v] = WOQL.localize({ consSubject, valueVar, last_cell: null });
  * return localized(

lib/typedef.js

@@ -226,4 +226,23 @@ const { ACTIONS } = Utils.ACTIONS;
  * Additional properties depend on the specific WOQL operation type
  */
 
-module.exports = {};
+/**
+ * @typedef {Object} WOQLQuery - WOQL Query Builder class
+ */
+
+/**
+ * Result from WOQL.localize() function - a two-element array [localizedFn, vars]
+ * @typedef {Object} LocalizeResult
+ * @property {function(WOQLQuery=): WOQLQuery} 0 - Localized function that wraps queries
+ * @property {Object.<string, Var>} 1 - Variables object with unique names
+ */
+
+// eslint-disable-next-line no-unused-vars
+const WOQLJson = {};
+// eslint-disable-next-line no-unused-vars
+const WOQLQuery = {};
+
+module.exports = {
+  WOQLJson,
+  WOQLQuery,
+};

lib/woqlClient.js

@@ -1995,4 +1995,97 @@ WOQLClient.prototype.sendCustomRequest = function (requestType, customRequestURL
   ).then((response) => response);
 };
 
+/**
+ * Get a single prefix mapping
+ * @param {string} prefixName - The prefix name (e.g., 'ex', 'schema')
+ * @param {string} [dbId] - The database id
+ * @returns {Promise<string>} A promise that returns the prefix IRI, or an Error if rejected.
+ * @example
+ * client.getPrefix("schema").then(uri => {
+ *   console.log(uri) // "http://schema.org/"
+ * })
+ */
+WOQLClient.prototype.getPrefix = function (prefixName, dbId) {
+  if (dbId) {
+    this.db(dbId);
+  }
+  const url = `${this.connectionConfig.prefixURL()}/${prefixName}`;
+  return this.dispatch(CONST.GET, url).then((response) => response['api:prefix_uri']);
+};
+
+/**
+ * Add a new prefix mapping
+ * @param {string} prefixName - The prefix name to create
+ * @param {string} uri - The IRI (namespace URL) this prefix expands to
+ * @param {string} [dbId] - The database id
+ * @returns {Promise} A promise that returns the call response object, or an Error if rejected.
+ * @example
+ * client.addPrefix("ex", "http://example.org/").then(result => {
+ *   console.log("Prefix added successfully")
+ * })
+ */
+WOQLClient.prototype.addPrefix = function (prefixName, uri, dbId) {
+  if (dbId) {
+    this.db(dbId);
+  }
+  const url = `${this.connectionConfig.prefixURL()}/${prefixName}`;
+  return this.dispatch(CONST.POST, url, { uri });
+};
+
+/**
+ * Update an existing prefix mapping
+ * @param {string} prefixName - The prefix name to update
+ * @param {string} uri - The new IRI for this prefix
+ * @param {string} [dbId] - The database id
+ * @returns {Promise} A promise that returns the call response object, or an Error if rejected.
+ * @example
+ * client.updatePrefix("ex", "http://example.com/").then(result => {
+ *   console.log("Prefix updated successfully")
+ * })
+ */
+WOQLClient.prototype.updatePrefix = function (prefixName, uri, dbId) {
+  if (dbId) {
+    this.db(dbId);
+  }
+  const url = `${this.connectionConfig.prefixURL()}/${prefixName}`;
+  return this.dispatch(CONST.PUT, url, { uri });
+};
+
+/**
+ * Create or update a prefix mapping (upsert)
+ * @param {string} prefixName - The prefix name
+ * @param {string} uri - The IRI for this prefix
+ * @param {string} [dbId] - The database id
+ * @returns {Promise} A promise that returns the call response object, or an Error if rejected.
+ * @example
+ * client.upsertPrefix("ex", "http://example.org/").then(result => {
+ *   console.log("Prefix created or updated successfully")
+ * })
+ */
+WOQLClient.prototype.upsertPrefix = function (prefixName, uri, dbId) {
+  if (dbId) {
+    this.db(dbId);
+  }
+  const url = `${this.connectionConfig.prefixURL()}/${prefixName}?create=true`;
+  return this.dispatch(CONST.PUT, url, { uri });
+};
+
+/**
+ * Delete a prefix mapping
+ * @param {string} prefixName - The prefix name to delete
+ * @param {string} [dbId] - The database id
+ * @returns {Promise} A promise that returns the call response object, or an Error if rejected.
+ * @example
+ * client.deletePrefix("ex").then(result => {
+ *   console.log("Prefix deleted successfully")
+ * })
+ */
+WOQLClient.prototype.deletePrefix = function (prefixName, dbId) {
+  if (dbId) {
+    this.db(dbId);
+  }
+  const url = `${this.connectionConfig.prefixURL()}/${prefixName}`;
+  return this.dispatch(CONST.DELETE, url);
+};
+
 module.exports = WOQLClient;