edge-functions 1.0.0

package/lib/platform/services/application.service.js

@@ -0,0 +1,140 @@
+import BaseService from './base.service.js';
+
+/**
+ * Class representing the Application Service.
+ * @augments BaseService
+ */
+class ApplicationService extends BaseService {
+  /**
+   * Create an instance of the ApplicationService.
+   */
+  constructor() {
+    super('/edge_applications');
+  }
+
+  /**
+   * Get all applications.
+   * @returns {Promise} A Promise representing the result of the API call.
+   */
+  getAll() {
+    return super.get();
+  }
+
+  /**
+   * Get an application by ID.
+   * @param {string} id - The ID of the application.
+   * @returns {Promise} A Promise representing the result of the API call.
+   */
+  getById(id) {
+    return super.get(`/${id}`);
+  }
+
+  /**
+   * Create a new application.
+   * @param {object} payload - The payload for creating the application.
+   * @param {string} payload.name - The name of the application.
+   * @param {string} payload.delivery_protocol - The delivery protocol for the application.
+   * @returns {Promise} A Promise representing the result of the API call.
+   */
+  create(payload) {
+    return super.post('', JSON.stringify(payload));
+  }
+
+  /**
+   * Update an application.
+   * @param {string} id - The ID of the application to update.
+   * @param {object} payload - The payload for updating the application.
+   * @param {string} payload.name - The updated name of the application.
+   * @param {string} payload.delivery_protocol - The updated delivery protocol for the application.
+   * @returns {Promise} A Promise representing the result of the API call.
+   */
+  update(id, payload) {
+    return super.patch(`/${id}`, JSON.stringify(payload));
+  }
+
+  /**
+   * Delete an application.
+   * @param {string} id - The ID of the application to delete.
+   * @returns {Promise} A Promise representing the result of the API call.
+   */
+  delete(id) {
+    return super.delete(`/${id}`);
+  }
+
+  /**
+   * Instantiate a function instance for an application.
+   * @param {string} applicationId - The ID of the application.
+   * @param {object} payload - The payload for instantiating the function instance.
+   * @param {number} payload.edge_function_id - The ID of the edge function to be instantiated.
+   * @param {object} payload.args - Additional arguments for the function instance.
+   * @returns {Promise} A Promise representing the result of the API call.
+   */
+  instantiate(applicationId, payload) {
+    return super.post(`/${applicationId}/functions_instances`, JSON.stringify(payload));
+  }
+
+  /**
+   * Create a rule for an application.
+   * @param {string} applicationId - The ID of the application.
+   * @param {object} payload - The payload for creating the rule.
+   * @returns {Promise} A Promise representing the result of the API call.
+   */
+  createRule(applicationId, payload) {
+    return super.post(`/${applicationId}/rules_engine/request/rules`, JSON.stringify(payload));
+  }
+
+  /**
+   * Update a rule for an application.
+   * @param {string} applicationId - The ID of the application.
+   * @param {string} ruleId - The ID of the rule to update.
+   * @param {object} payload - The payload for updating the rule.
+   * @returns {Promise} A Promise representing the result of the API call.
+   */
+  updateRule(applicationId, ruleId, payload) {
+    return super.patch(`/${applicationId}/rules_engine/request/rules/${ruleId}`, JSON.stringify(payload));
+  }
+
+  /**
+   * Get an application rules.
+   * @param {string} applicationId - The ID of the application to get rules.
+   * @returns {Promise} A Promise representing the result of the API call.
+   */
+  getRules(applicationId) {
+    return super.get(`/${applicationId}/rules_engine/request/rules`);
+  }
+}
+
+/**
+ * @name ApplicationService
+ * Instance of the Application Service.
+ * This instance provides methods to interact with Azion's Application service,
+ * such as creating, updating, and deleting applications, as well as retrieving application details.
+ * @type {BaseService}
+ * @memberof Services
+ * @function create
+ * @function update
+ * @function getAll
+ * @function getById
+ * @function delete
+ * @function instantiate
+ * @function createRule
+ * @function updateRule
+ * @function getRules
+ * @example
+ *
+ * // Example usage
+ * const payload = {
+ *   name: "My Application",
+ *   delivery_protocol: "http,https"
+ * };
+ *
+ * ApplicationService.create(payload)
+ *   .then((response) => {
+ *     console.log(response);
+ *   })
+ *   .catch((error) => {
+ *     feedback.error(error);
+ *   });
+ */
+const ApplicationServiceInstance = new ApplicationService();
+export default ApplicationServiceInstance;

package/lib/platform/services/base.service.js

@@ -0,0 +1,200 @@
+import { vulcan } from '#env';
+import _ from 'lodash';
+
+const env = globalThis.vulcan?.env ? globalThis.vulcan.env : 'production';
+
+const APIS = {
+  local: 'http://localhost:8082',
+  stage: 'https://stage-api.azion.net',
+  production: 'https://api.azionapi.net',
+};
+
+/**
+ * Removes leading and trailing slashes from a resource string.
+ * @param {string} resource - The resource string to process.
+ * @returns {string} The processed resource string without leading and trailing slashes.
+ */
+const removeLeadingAndTrailingSlashes = (resource) => (resource ? `/${resource.toString().replace(/^\/|\/$/g, '')}` : '');
+
+/**
+ * Reads the API token from the Vulcan environment.
+ * @async
+ * @returns {Promise<string>} A Promise that resolves to the API token.
+ */
+/**
+/**
+Retrieves the API authentication token from the Vulcan environment
+and returns it as a header object.
+ * @returns {Promise<object>} A Promise that resolves to an object
+ * containing the token in the format { headers: { Authorization: 'Token ${value}' } }.
+ */
+const getAuthHeaders = async () => {
+  const token = (await vulcan.readVulcanEnv()).API_TOKEN;
+  return { headers: { Authorization: `Token ${token}` } };
+};
+
+/**
+ * The BaseService class provides a foundation for communicating with the Azion platform.
+ *  It enables the sending of HTTP requests to various APIs,
+ * including local, staging, and production endpoints.
+ * In addition to standard GET, POST, PUT, PATCH, and DELETE requests,
+ *  BaseService also supports GraphQL queries
+ * BaseService includes methods for GET, POST, PUT, PATCH, DELETE, and GraphQL requests.
+ * @namespace Services
+ * @class BaseService
+ * @type {BaseService}
+ * @example
+ * class FrodoService extends BaseService {
+ *   constructor() {
+ *     super('frodoApi', '/v3', { headers: { 'Content-Type': 'text/plain' } });
+ *   }
+ *
+ *   getRing() {
+ *     return super.get('/rings');
+ *   }
+ *   postLembas(lembas){
+ *     return super.post('/lembas', lembas)
+ *   }
+ * }
+ */
+class BaseService {
+  /**
+   * Create a base service.
+   * @param {string} resource -  @param {string} resource - The resource of the API. If it starts with "http://" or "https://", it will be used as is. Otherwise, it will be concatenated with the API based on the environment.
+   * @param {object} config - The configuration for the service.
+   */
+  constructor(resource, config) {
+    if (resource && /^(https?:\/\/)/.test(resource)) this.base = resource;
+    else this.base = APIS[env] + (resource || '');
+
+    this.config = {
+      timeout: 90000,
+      headers: {
+        'Content-Type': 'application/json',
+        Accept: 'application/json; version=3',
+      },
+      ...config,
+    };
+  }
+
+  /**
+   * Send a GET request.
+   * @param {string} resource - The Resource to request.
+   * @param {object} config - The configuration for the request.
+   * @returns {Promise} The Promise object representing the fetch operation.
+   */
+  async get(resource, config) {
+    const fullUrl = this.base + removeLeadingAndTrailingSlashes(resource);
+    const authHeaders = config?.headers?.Authorization
+      ? {}
+      : await getAuthHeaders();
+    const mergedConfig = _.merge({}, authHeaders, this.config, config);
+    return fetch(fullUrl, {
+      method: 'GET',
+      ...mergedConfig,
+    });
+  }
+
+  /**
+   * Send a GraphQL GET request.
+   * @param {string} resource - The resource path of the GraphQL endpoint.
+   * @param {object} config - The configuration for the request.
+   * @param {string} query - The GraphQL query string.
+   * @returns {Promise} The Promise object representing the fetch operation.
+   */
+  async graphQl(resource, config, query) {
+    const fullUrl = this.base + removeLeadingAndTrailingSlashes(resource);
+    const authHeaders = config?.headers?.Authorization
+      ? {}
+      : await getAuthHeaders();
+    const mergedConfig = _.merge({}, authHeaders, this.config, config);
+    const payload = {
+      query,
+    };
+    return fetch(fullUrl, {
+      method: 'POST',
+      body: JSON.stringify(payload),
+      ...mergedConfig,
+    });
+  }
+
+  /**
+   * Send a POST request.
+   * @param {string} resource - The Resource to request.
+   * @param {object} data - The data to send in the body of the request.
+   * @param {object} config - The configuration for the request.
+   * @returns {Promise} The Promise object representing the fetch operation.
+   */
+  async post(resource, data, config) {
+    const fullUrl = this.base + removeLeadingAndTrailingSlashes(resource);
+    const authHeaders = config?.headers?.Authorization
+      ? {}
+      : await getAuthHeaders();
+    const mergedConfig = _.merge({}, authHeaders, this.config, config);
+    return fetch(fullUrl, {
+      method: 'POST',
+      body: data,
+      ...mergedConfig,
+    });
+  }
+
+  /**
+   * Send a PUT request.
+   * @param {string} resource - The Resource to request.
+   * @param {object} data - The data to send in the body of the request.
+   * @param {object} config - The configuration for the request.
+   * @returns {Promise} The Promise object representing the fetch operation.
+   */
+  async put(resource, data, config) {
+    const fullUrl = this.base + removeLeadingAndTrailingSlashes(resource);
+    const authHeaders = config?.headers?.Authorization
+      ? {}
+      : await getAuthHeaders();
+    const mergedConfig = _.merge({}, authHeaders, this.config, config);
+    return fetch(fullUrl, {
+      method: 'PUT',
+      body: data,
+      ...mergedConfig,
+    });
+  }
+
+  /**
+   * Send a PATCH request.
+   * @param {string} resource - The Resource to request.
+   * @param {object} data - The data to send in the body of the request.
+   * @param {object} config - The configuration for the request.
+   * @returns {Promise} The Promise object representing the fetch operation.
+   */
+  async patch(resource, data, config) {
+    const fullUrl = this.base + removeLeadingAndTrailingSlashes(resource);
+    const authHeaders = config?.headers?.Authorization
+      ? {}
+      : await getAuthHeaders();
+    const mergedConfig = _.merge({}, authHeaders, this.config, config);
+    return fetch(fullUrl, {
+      method: 'PATCH',
+      body: data,
+      ...mergedConfig,
+    });
+  }
+
+  /**
+   * Send a DELETE request.
+   * @param {string} resource - The Resource to request.
+   * @param {object} config - The configuration for the request.
+   * @returns {Promise} The Promise object representing the fetch operation.
+   */
+  async delete(resource, config) {
+    const fullUrl = this.base + removeLeadingAndTrailingSlashes(resource);
+    const authHeaders = config?.headers?.Authorization
+      ? {}
+      : await getAuthHeaders();
+    const mergedConfig = _.merge({}, authHeaders, this.config, config);
+    return fetch(fullUrl, {
+      method: 'DELETE',
+      ...mergedConfig,
+    });
+  }
+}
+
+export default BaseService;

package/lib/platform/services/domain.service.js

@@ -0,0 +1,80 @@
+import BaseService from './base.service.js';
+
+/**
+ * Class representing the Domain Service.
+ * @augments BaseService
+ */
+class DomainService extends BaseService {
+  /**
+   * Create an instance of the DomainService.
+   */
+  constructor() {
+    super('/domains');
+  }
+
+  /**
+   * Get all domains.
+   * @returns {Promise} A Promise representing the result of the API call.
+   */
+  getAll() {
+    return super.get();
+  }
+
+  /**
+   * Get a domain by ID.
+   * @param {string} id - The ID of the domain.
+   * @returns {Promise} A Promise representing the result of the API call.
+   */
+  getById(id) {
+    return super.get(`/${id}`);
+  }
+
+  /**
+   * Create a new domain.
+   * @param {object} payload - The payload for creating the domain.
+   * @param {string} payload.name - The name of the domain.
+   * @param {boolean} payload.cname_access_only - Whether the domain should
+   * be accessed only via CNAME.
+   * @param {number|null} payload.digital_certificate_id - The ID of the digital certificate
+   * to be associated with the domain.
+   * @param {number} payload.edge_application_id - The ID of the edge application
+   * to which the domain belongs.
+   * @param {boolean} payload.is_active - Whether the domain is active.
+   * @returns {Promise} A Promise representing the result of the API call.
+   */
+  create(payload) {
+    return super.post('', JSON.stringify(payload));
+  }
+}
+
+/**
+ * Instance of the Domain Service.
+ * This instance provides methods to interact with the Azion Domain API,
+ * such as retrieving domains, getting domain details, and creating new domains.
+ * @type {BaseService}
+ * @memberof Services
+ * @function DomainService.getAll
+ * @function DomainService.getById
+ * @function DomainService.create
+ * @example
+ *
+ * // Example usage
+ * const payload = {
+ *   name: 'example.com',
+ *   cname_access_only: true,
+ *   digital_certificate_id: 12345,
+ *   edge_application_id: 67890,
+ *   is_active: true
+ * };
+ *
+ * DomainService.create(payload)
+ *   .then((response) => {
+ *     console.log(response);
+ *   })
+ *   .catch((error) => {
+ *     feedback.error(error);
+ *   });
+ */
+const DomainServiceInstance = new DomainService();
+
+export default DomainServiceInstance;

package/lib/platform/services/events.service.js

@@ -0,0 +1,65 @@
+import BaseService from './base.service.js';
+
+/**
+ * Class representing the Events Service.
+ * @augments BaseService
+ */
+class EventsService extends BaseService {
+  /**
+   * Create an instance of the EventsService.
+   */
+  constructor() {
+    super('/events/graphql');
+  }
+
+  /**
+   * Get the console logs for a specific function.
+   * @param {string} functionId - The ID of the function.
+   * @returns {Promise} A Promise representing the result of the API call.
+   */
+  getFunctionsLogs(functionId) {
+    const filter = functionId ? `functionId: "${functionId}"` : '';
+
+    return super.graphQl('', '', `
+      query ConsoleLog {
+        cellsConsoleEvents(
+          limit: 10
+          ${filter ? `filter: { ${filter} }` : ''}
+          orderBy: [ts_DESC]
+        ) {
+          ts
+          solutionId
+          configurationId
+          functionId
+          id 
+          lineSource 
+          level 
+          line
+        }
+      }
+    `);
+  }
+}
+/**
+ * @name EventsService
+ * @memberof Services
+ * Instance of the Events Service.
+ * This instance provides methods to interact with Azion's Events service,
+ * such as retrieving console logs for a specific function.
+ * @type {BaseService}
+ * @function EventsService.getFunctionsLogs
+ * @example
+ *
+ * // Example usage
+ * const functionId = '12345';
+ *
+ * EventsService.getFunctionsLogs(functionId)
+ *   .then((response) => {
+ *     console.log(response);
+ *   })
+ *   .catch((error) => {
+ *     feedback.error(error);
+ *   });
+ */
+const EventsServiceInstance = new EventsService();
+export default EventsServiceInstance;

package/lib/platform/services/function.service.js

@@ -0,0 +1,105 @@
+import BaseService from './base.service.js';
+
+/**
+ * Class representing the Function Service.
+ * @augments BaseService
+ */
+class FunctionService extends BaseService {
+  /**
+   * Create an instance of the FunctionService.
+   */
+  constructor() {
+    super('/edge_functions');
+  }
+
+  /**
+   * Get all functions.
+   * @returns {Promise} A Promise representing the result of the API call.
+   */
+  getAll() {
+    return super.get();
+  }
+
+  /**
+   * Get a function by ID.
+   * @param {string} id - The ID of the function.
+   * @returns {Promise} A Promise representing the result of the API call.
+   */
+  getById(id) {
+    return super.get(`/${id}`);
+  }
+
+  /**
+   * Create a new function.
+   * @param {object} payload - The payload for creating the function.
+   * @param {string} payload.name - The name of the function.
+   * @param {string} payload.code - The code of the function.
+   * @param {string} payload.language - The language of the function.
+   * @param {string} payload.initiator_type - The initiator type of the function.
+   * @param {object} payload.json_args - The JSON arguments of the function.
+   * @param {boolean} payload.active - The status of the function (active or inactive).
+   * @returns {Promise} A Promise representing the result of the API call.
+   */
+  create(payload) {
+    return super.post('', JSON.stringify(payload));
+  }
+
+  /**
+   * Update a function by ID.
+   * @param {string} id - The ID of the function.
+   * @param {object} payload - The payload for updating the function.
+   * @param {string} payload.name - The updated name of the function.
+   * @param {string} payload.code - The updated code of the function.
+   * @param {string} payload.language - The updated language of the function.
+   * @param {string} payload.initiator_type - The updated initiator type of the function.
+   * @param {object} payload.json_args - The updated JSON arguments of the function.
+   * @param {boolean} payload.active - The updated status of the function (active or inactive).
+   * @returns {Promise} A Promise representing the result of the API call.
+   */
+  update(id, payload) {
+    return super.patch(`/${id}`, JSON.stringify(payload));
+  }
+
+  /**
+   * Delete a function by ID.
+   * @param {string} id - The ID of the function to delete.
+   * @returns {Promise} A Promise representing the result of the API call.
+   */
+  delete(id) {
+    return super.delete(`/${id}`);
+  }
+}
+/**
+ * @name FunctionService
+ * @memberof Services
+ * Instance of the Function Service.
+ * This instance provides methods to interact with Azion's Function service,
+ * such as creating, updating, and deleting functions, as well as retrieving function details.
+ * @type {BaseService}
+ * @function FunctionService.create
+ * @function FunctionService.update
+ * @function FunctionService.getAll
+ * @function FunctionService.getById
+ * @example
+ * const functionService = new FunctionService();
+ *
+ * // Example usage
+ *   const payload = {
+      name: "Function One"
+      code: "...",
+      language: "javascript",
+      initiator_type: "edge_application",
+      json_args: {},
+      active: true
+    };
+ *
+ * functionService.create(payload)
+ *   .then((response) => {
+ *     console.log(response);
+ *   })
+ *   .catch((error) => {
+ *     feedback.error(error);
+ *   });
+ */
+const FunctionServiceInstance = new FunctionService();
+export default FunctionServiceInstance;

package/lib/platform/services/index.js

@@ -0,0 +1,8 @@
+import TokensService from './tokens.service.js';
+import ApplicationService from './application.service.js';
+import DomainService from './domain.service.js';
+import FunctionService from './function.service.js';
+
+export {
+  TokensService, ApplicationService, DomainService, FunctionService,
+};

package/lib/platform/services/storage.service.js

@@ -0,0 +1,59 @@
+import BaseService from './base.service.js';
+
+/**
+ * Service for interacting with the Azion Storage API.
+ * Extends the BaseService class.
+ */
+class StorageService extends BaseService {
+  /**
+   * Constructs a new instance of the StorageService.
+   * Sets the base URL for the Storage API.
+   */
+  constructor() {
+    super('https://storage-api.azion.com/storage');
+  }
+
+  /**
+   * Uploads a file to the specified version ID in the storage API.
+   * @param {string} versionId - The version ID for the file.
+   * @param {string} file - The file content as a String.
+   * @param {string} staticPath - The static path for the asset.
+   * @param {string} contentType - The content type of the file.
+   * @returns {Promise} A promise that resolves with the API response.
+   */
+  async upload(versionId, file, staticPath, contentType) {
+    return super.post(`${versionId}`, file, {
+      headers: {
+        'X-Azion-Static-Path': staticPath,
+        'Content-Type': contentType,
+      },
+    });
+  }
+}
+
+/**
+ * @name StorageService
+ * @memberof Services
+ * Instance of the Storage Service.
+ * This instance provides methods to interact with the Azion Storage API,
+ * such as uploading files to the storage.
+ * @type {BaseService}
+ * @function StorageService.upload
+ * @example
+ *
+ * // Example usage
+ * const versionId = '12345';
+ * const fileContent = '...'; // File content as a string
+ * const staticPath = '/assets/images/';
+ * const contentType = 'text/javascript';
+ *
+ * StorageService.upload(versionId, fileContent, staticPath, contentType)
+ *   .then((response) => {
+ *     console.log(response);
+ *   })
+ *   .catch((error) => {
+ *     feedback.error(error);
+ *   });
+ */
+const StorageServiceInstance = new StorageService();
+export default StorageServiceInstance;