@skedulo/pulse-solution-services 0.0.5

package/README.md

@@ -0,0 +1,161 @@
+# Pulse Solution Services
+
+**@skedulo/pulse-solution-services** provides common services and utilities for building solutions on the Pulse platform.
+
+## Installation
+
+```bash
+npm install @skedulo/pulse-solution-services
+```
+or 
+```bash
+yarn add @skedulo/pulse-solution-services
+```
+
+## Quick Start
+### Initialize Execution Context
+
+**From a function**
+```javascript
+const context = ExecutionContext.fromContext(skedToken);
+```
+**From other execution contexts**
+```javascript
+const context = ExecutionContext.fromCredentials({
+  apiServer: user.apiBasePath,
+  apiToken: user.user.accessToken,
+});
+```
+### API Clients
+
+**Metadata Client**
+Fetches metadata from `/metadata` endpoints.
+```javascript
+// Calls /metadata endpoint to retrieve all metadata 
+const metadata = await context.metadataClient.fetchAllMetadata();
+
+// Calls /metadata/{mapping} endpoint to fetches metadata for a specific object
+const jobMetadata = await context.metadataClient.fetchObjectMetadata('job');
+```
+
+**GraphQL Client**
+Executes GraphQL queries and mutations against `/graphql/graphql`.
+```javascript
+const queryResult = await context.graphqlClient.query(queryParams);
+```
+
+**Config Variable Client**
+Provides CRUD and search methods for managing configuration variables.
+```javascript
+// Calls /configuration/extension endpoint to create a configuration var
+await context.configVarClient.create({
+  key: "TEST_KEY",
+  value: "TEST_VALUE",
+  configType: "plain-text",
+  description: "TEST_DESCRIPTION",
+});
+// Gets a config var
+const config = await context.configVarClient.get('TEST_KEY');
+```
+
+### GraphQL Service
+
+**Query data**
+```javascript
+// Create a query builder for the Resources object
+const queryBuilder = context.newQueryBuilder('Resources')
+                            .withFields(['UID', 'Name'])
+                            .withFilter('IsActive == true') 
+                            .withLimit(1)
+                            .withOffset(1)
+                            .withOrderBy('Name ASC');
+// Add a child query for Job Allocations
+queryBuilder.withChildQuery('JobAllocations')
+            .withFields(['UID', 'Name'])
+            .withParentQuery('Job')
+              .withFields(['UID', 'Name']);
+// Add a parent query for Primary Region       
+queryBuilder.withParentQuery('PrimaryRegion')
+            .withFields(['UID', 'Name']); 
+// Finally, execute the query via your GraphQL service
+const queryResult: QueryResult = await context.graphqlService.query(queryBuilder.build());
+
+console.log(queryResult.records);
+console.log(queryResult.totalCount); // 5
+console.log(queryResult.pageInfo.hasNextPage); // true
+console.log(queryResult.endCursor); // Mg==
+console.log(queryResult.endOffset); // 1
+```
+**Update data**
+```javascript
+const recordsToUpdate = queryResult.records.map((record) => {
+  return {
+    UID: record.UID,
+    Name: record.Name + " - Updated"
+  }
+});
+const updateResult = await context.graphqlService.update('Resources', recordsToUpdate);
+```
+**Pagination with offset**
+```javascript
+while(queryResult.pageInfo.hasNextPage) {
+  queryBuilder.withOffset(queryResult.endOffset + 1);
+  queryResult = await context.graphqlService.query(queryBuilder.build());
+}
+```
+**Pagination with cursor**
+```javascript
+while(queryResult.pageInfo.hasNextPage) {
+  queryBuilder.withCursor(queryResult.endCursor);
+  queryResult = await context.graphqlService.query(queryBuilder.build());
+}
+```
+
+### Batch Service
+The Batch Service offers a flexible and scalable solution for large-scale data processing.
+```javascript
+const job = {
+  CreatedDate: new Date().toISOString(),
+  JobType: 'Delete',
+  ObjectName: 'Accounts',
+  Fields: "UID",
+  BatchSize: 100,
+  MaximumBatches: 10
+};
+
+const context = ExecutionContext.fromCredentials({
+  apiServer: user.apiBasePath,
+  apiToken: user.user.accessToken,
+});
+context.contextData.job = job;
+const orchestrator = new BatchOrchestrator(context, {
+  isAsyncProcessing: false,
+});
+await orchestrator.processBatchJob();
+```
+
+### Cache Service
+The Cache Service enables efficient data sharing between function executions and improves performance by reducing redundant operations and API calls.
+```javascript
+// Multi-layer cache 
+const metadata: object[] = await context.inMemoryCache.get(
+  "METADATA",{
+    useSecondaryCache: true,
+  }
+)
+```
+
+### Logging Utils
+The log method decorator helps streamline debugging by tracking key function executions, including their inputs and outputs. 
+```javascript
+class ExampleService {
+  @LogMethod("example_space")
+  processData(input: string): string {
+    return `Processed: ${input}`;
+  }
+}
+```
+Two environment variables control logging behavior:
+
+- LOG_NAMESPACE: Filters logs by a specific namespace or displays all logs. The namespace for services in this library is PSS.
+- LOG_ENTRY_MAX_LENGTH: Defaults to 120 but can be increased to capture complete input/output data.

package/dist/clients/base-client.js

@@ -0,0 +1 @@
+"use strict";var __decorate=this&&this.__decorate||function(e,t,n,o){var i,r=arguments.length,a=r<3?t:null===o?o=Object.getOwnPropertyDescriptor(t,n):o;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)a=Reflect.decorate(e,t,n,o);else for(var s=e.length-1;s>=0;s--)(i=e[s])&&(a=(r<3?i(a):r>3?i(t,n,a):i(t,n))||a);return r>3&&a&&Object.defineProperty(t,n,a),a},__metadata=this&&this.__metadata||function(e,t){if("object"==typeof Reflect&&"function"==typeof Reflect.metadata)return Reflect.metadata(e,t)},__awaiter=this&&this.__awaiter||function(e,t,n,o){return new(n||(n=Promise))((function(i,r){function a(e){try{c(o.next(e))}catch(e){r(e)}}function s(e){try{c(o.throw(e))}catch(e){r(e)}}function c(e){var t;e.done?i(e.value):(t=e.value,t instanceof n?t:new n((function(e){e(t)}))).then(a,s)}c((o=o.apply(e,t||[])).next())}))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.BaseClient=void 0;const logging_1=require("../logging");class BaseClient{constructor(e){this.config=e}getHeaders(){return{Authorization:`Bearer ${this.config.apiToken}`,"Content-Type":"application/json"}}performRequest(e){return __awaiter(this,arguments,void 0,(function*({method:e="GET",endpoint:t,headers:n={},body:o}){try{const i=Object.assign(Object.assign({},this.getHeaders()),n),r=yield fetch(`${this.config.apiServer}/${t}`,{method:e,headers:i,body:o?JSON.stringify(o):void 0});let a;const s=r.headers.get("content-type");if(a=s&&s.includes("application/json")?yield r.json():yield r.text(),!r.ok)throw new Error(`HTTP error! Status: ${r.status}. Response: ${JSON.stringify(a)}`);return a}catch(e){throw this.handleException(e),e}}))}handleException(e){}}exports.BaseClient=BaseClient,__decorate([(0,logging_1.LogMethod)(),__metadata("design:type",Function),__metadata("design:paramtypes",[Object]),__metadata("design:returntype",Promise)],BaseClient.prototype,"performRequest",null);

package/dist/clients/config-var-client.js

@@ -0,0 +1 @@
+"use strict";var __awaiter=this&&this.__awaiter||function(t,e,n,i){return new(n||(n=Promise))((function(o,r){function s(t){try{_(i.next(t))}catch(t){r(t)}}function a(t){try{_(i.throw(t))}catch(t){r(t)}}function _(t){var e;t.done?o(t.value):(e=t.value,e instanceof n?e:new n((function(t){t(e)}))).then(s,a)}_((i=i.apply(t,e||[])).next())}))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.ConfigVarClient=void 0;const constants_1=require("../constants"),base_client_1=require("./base-client");class ConfigVarClient extends base_client_1.BaseClient{create(t){return __awaiter(this,void 0,void 0,(function*(){return yield this.performRequest({method:constants_1.HTTP_METHOD.POST,endpoint:constants_1.TENANT_ENDPOINTS.CONFIG_VAR.CREATE,body:t})}))}get(t){return __awaiter(this,void 0,void 0,(function*(){return yield this.performRequest({endpoint:constants_1.TENANT_ENDPOINTS.CONFIG_VAR.GET(t)})}))}update(t){return __awaiter(this,void 0,void 0,(function*(){const e=t.key||"";return delete t.key,yield this.performRequest({method:constants_1.HTTP_METHOD.PATCH,endpoint:constants_1.TENANT_ENDPOINTS.CONFIG_VAR.UPDATE(e),body:{value:t.value,description:t.description}})}))}search(t){return __awaiter(this,void 0,void 0,(function*(){return yield this.performRequest({method:constants_1.HTTP_METHOD.POST,endpoint:constants_1.TENANT_ENDPOINTS.CONFIG_VAR.SEARCH,body:{pageSize:t&&t<1e3?t:1e3}})}))}delete(t){return __awaiter(this,void 0,void 0,(function*(){return yield this.performRequest({method:constants_1.HTTP_METHOD.DELETE,endpoint:constants_1.TENANT_ENDPOINTS.CONFIG_VAR.DELETE(t)})}))}}exports.ConfigVarClient=ConfigVarClient;

package/dist/clients/graphql-client.js

@@ -0,0 +1 @@
+"use strict";var __awaiter=this&&this.__awaiter||function(t,e,n,i){return new(n||(n=Promise))((function(r,s){function a(t){try{c(i.next(t))}catch(t){s(t)}}function o(t){try{c(i.throw(t))}catch(t){s(t)}}function c(t){var e;t.done?r(t.value):(e=t.value,e instanceof n?e:new n((function(t){t(e)}))).then(a,o)}c((i=i.apply(t,e||[])).next())}))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.GraphQLClient=void 0;const constants_1=require("../constants"),http_1=require("../constants/http"),base_client_1=require("./base-client");class GraphQLClient extends base_client_1.BaseClient{execute(t){return __awaiter(this,void 0,void 0,(function*(){return yield this.performRequest({method:http_1.HTTP_METHOD.POST,endpoint:constants_1.TENANT_ENDPOINTS.GRAPHQL,body:{query:t}})}))}}exports.GraphQLClient=GraphQLClient;

package/dist/clients/index.js

@@ -0,0 +1 @@
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,i){void 0===i&&(i=r);var o=Object.getOwnPropertyDescriptor(t,r);o&&!("get"in o?!t.__esModule:o.writable||o.configurable)||(o={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,i,o)}:function(e,t,r,i){void 0===i&&(i=r),e[i]=t[r]}),__exportStar=this&&this.__exportStar||function(e,t){for(var r in e)"default"===r||Object.prototype.hasOwnProperty.call(t,r)||__createBinding(t,e,r)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("../services/metadata-service"),exports),__exportStar(require("./base-client"),exports),__exportStar(require("./config-var-client"),exports),__exportStar(require("./graphql-client"),exports),__exportStar(require("./metadata-client"),exports);

package/dist/clients/metadata-client.js

@@ -0,0 +1 @@
+"use strict";var __awaiter=this&&this.__awaiter||function(t,e,n,a){return new(n||(n=Promise))((function(i,r){function s(t){try{c(a.next(t))}catch(t){r(t)}}function o(t){try{c(a.throw(t))}catch(t){r(t)}}function c(t){var e;t.done?i(t.value):(e=t.value,e instanceof n?e:new n((function(t){t(e)}))).then(s,o)}c((a=a.apply(t,e||[])).next())}))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.MetadataClient=void 0;const constants_1=require("../constants"),base_client_1=require("./base-client");class MetadataClient extends base_client_1.BaseClient{fetchAllMetadata(){return __awaiter(this,void 0,void 0,(function*(){return yield this.performRequest({endpoint:constants_1.TENANT_ENDPOINTS.METADATA.ALL})}))}fetchObjectMetadata(t){return __awaiter(this,void 0,void 0,(function*(){return yield this.performRequest({endpoint:constants_1.TENANT_ENDPOINTS.METADATA.OBJECT(t)})}))}}exports.MetadataClient=MetadataClient;

package/dist/constants/config-var.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.CONFIG_VAR_STATUS=exports.CONFIG_VAR_TYPE=void 0,exports.CONFIG_VAR_TYPE={PLAIN_TEXT:"plain-text",SECRET:"secret"},exports.CONFIG_VAR_STATUS={ACTIVE:"active",INACTIVE:"inactive",EXPIRED:"expired"};

package/dist/constants/http.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.HTTP_METHOD=void 0,exports.HTTP_METHOD={GET:"GET",POST:"POST",PUT:"PUT",DELETE:"DELETE",PATCH:"PATCH"};

package/dist/constants/index.js

@@ -0,0 +1 @@
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,o){void 0===o&&(o=r);var i=Object.getOwnPropertyDescriptor(t,r);i&&!("get"in i?!t.__esModule:i.writable||i.configurable)||(i={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,o,i)}:function(e,t,r,o){void 0===o&&(o=r),e[o]=t[r]}),__exportStar=this&&this.__exportStar||function(e,t){for(var r in e)"default"===r||Object.prototype.hasOwnProperty.call(t,r)||__createBinding(t,e,r)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./config-var"),exports),__exportStar(require("./http"),exports),__exportStar(require("./tenant-endpoints"),exports),__exportStar(require("./tenant-objects"),exports);

package/dist/constants/tenant-endpoints.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.TENANT_ENDPOINTS=void 0,exports.TENANT_ENDPOINTS={CONFIG_VAR:{CREATE:"configuration/extension",GET:e=>`configuration/extension/${e}`,UPDATE:e=>`configuration/extension/${e}`,DELETE:e=>`configuration/extension/${e}`,SEARCH:"configuration/extension/search"},GRAPHQL:"graphql/graphql",METADATA:{ALL:"custom/metadata",OBJECT:e=>`custom/metadata/${e}`}};

package/dist/constants/tenant-objects.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.TENANT_OBJECTS=void 0,exports.TENANT_OBJECTS={Accounts:"Accounts",Jobs:"Jobs",JobAllocations:"JobAllocations",Regions:"Regions",Contacts:"Contacts",Locations:"Locations",Resources:"Resources",Tags:"Tags",JobTags:"JobTags",ResourceTags:"ResourceTags",Activities:"Activities",Availabilities:"Availabilities",Holidays:"Holidays",AvailabilityPatterns:"AvailabilityPatterns",AvailabilityPatternResources:"AvailabilityPatternResources",AccountResourceScores:"AccountResourceScores",LocationResourceScores:"LocationResourceScores",Products:"Products",JobProducts:"JobProducts"};

package/dist/core/execution-context.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ExecutionContext=void 0;const function_utilities_1=require("@skedulo/function-utilities"),config_var_client_1=require("../clients/config-var-client"),graphql_client_1=require("../clients/graphql-client"),metadata_client_1=require("../clients/metadata-client"),logging_1=require("../logging"),cache_service_1=require("../services/cache/cache-service"),storage_1=require("../services/cache/storage"),graphql_1=require("../services/graphql"),metadata_service_1=require("../services/metadata-service"),utils_1=require("../utils");class ExecutionContext{constructor(e){this.skedContext=e,this.contextData={},this.baseConfig={apiToken:e.auth.token,apiServer:e.auth.baseUrl}}static fromContext(e){return new ExecutionContext(e)}static fromCredentials({apiServer:e,apiToken:t}){const i={Authorization:`Bearer ${t}`,"sked-api-server":e},r=(0,function_utilities_1.createSkedContext)(i);return new ExecutionContext(r)}get logger(){return this._logger=this.lazyInit(this._logger,(()=>new logging_1.Logger))}get configHelper(){return this._configHelper=this.lazyInit(this._configHelper,(()=>new utils_1.ConfigHelper(this.skedContext.configVars)))}get graphqlClient(){return this._graphqlClient=this.lazyInit(this._graphqlClient,(()=>new graphql_client_1.GraphQLClient(this.baseConfig)))}get graphqlService(){return this._graphqlService=this.lazyInit(this._graphqlService,(()=>new graphql_1.GraphQLService(this.graphqlClient)))}newQueryBuilder(e){return new graphql_1.GraphQLQueryBuilder(e)}get metadataClient(){return this._metadataClient=this.lazyInit(this._metadataClient,(()=>new metadata_client_1.MetadataClient(this.baseConfig)))}get metadataService(){return this._metadataService=this.lazyInit(this._metadataService,(()=>new metadata_service_1.MetadataService(this.metadataClient)))}get configVarClient(){return this._configVarClient=this.lazyInit(this._configVarClient,(()=>new config_var_client_1.ConfigVarClient(this.baseConfig)))}get configVarCache(){if(!this._configVarCache){if(!this.configVarClient)throw new Error("ConfigVarClient is not initialized.");this._configVarCache=this.lazyInit(this._configVarCache,(()=>new cache_service_1.CacheService(new storage_1.ConfigVarCacheStorage(this.configVarClient))))}return this._configVarCache}get inMemoryCache(){return this._inMemoryCache||(this._inMemoryCache=this.lazyInit(this._inMemoryCache,(()=>new cache_service_1.CacheService(new storage_1.InMemoryCacheStorage))),this._inMemoryCache.setSecondaryCache(this.configVarCache)),this._inMemoryCache}dispose(){this._logger=void 0,this._configHelper=void 0,this._graphqlClient=void 0,this._graphqlService=void 0,this._metadataClient=void 0,this._metadataService=void 0,this._configVarClient=void 0,this._inMemoryCache=void 0}lazyInit(e,t){return null!=e?e:t()}}exports.ExecutionContext=ExecutionContext;

package/dist/core/index.js

@@ -0,0 +1 @@
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,i){void 0===i&&(i=r);var n=Object.getOwnPropertyDescriptor(t,r);n&&!("get"in n?!t.__esModule:n.writable||n.configurable)||(n={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,i,n)}:function(e,t,r,i){void 0===i&&(i=r),e[i]=t[r]}),__exportStar=this&&this.__exportStar||function(e,t){for(var r in e)"default"===r||Object.prototype.hasOwnProperty.call(t,r)||__createBinding(t,e,r)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./execution-context"),exports);