@stackone/core 1.0.0 → 1.2.0

package/dist/baseConnector.d.ts

@@ -1,5 +1,5 @@
 import { IHttpClient } from '@stackone/transport';
-import { Bundle, HttpOperation, HttpOperations, IConnector, Operation, Service } from './types';
+import { Bundle, HttpOperation, HttpOperations, IConnector, Operation, ResponseFieldMetaData, Service } from './types';
 export declare abstract class BaseConnector implements IConnector {
     protected httpClient: IHttpClient;
     version: string;
@@ -31,6 +31,7 @@ export declare abstract class BaseConnector implements IConnector {
     });
     listOperations: () => string[];
     getOperation: (operationId: string) => HttpOperation;
+    getOperationResponseFieldsMetadata: (operationId: string) => ResponseFieldMetaData[] | null;
     callOperation: ({ operationId, params, credentials, }: {
         operationId: string;
         params?: Record<string, unknown> | undefined;

package/dist/blocks/blockFunctionsConfigs.d.ts

@@ -0,0 +1,2 @@
+import { BlockFieldConfigs, BlockFunction } from './types';
+export declare const getBlockPipeFunctionsFromConfig: (configs?: BlockFieldConfigs) => BlockFunction[];

package/dist/blocks/blockFunctionsFactory.d.ts

@@ -0,0 +1,5 @@
+import { BlockFunctionType } from './functions/functionsDirectoryTypes';
+import { BlockFunction } from './types';
+export declare class BlockFunctionsFactory {
+    static build(type: BlockFunctionType): BlockFunction;
+}

package/dist/blocks/blockPipe.d.ts

@@ -0,0 +1,2 @@
+import { Block, BlockFunction } from './types';
+export declare const blockPipe: (blockFunctions: BlockFunction[], block: Block) => Promise<Block>;

package/dist/blocks/functions/functionsDirectoryTypes.d.ts

@@ -0,0 +1,10 @@
+export declare enum BlockFunctionType {
+    MAP = "map"
+}
+export type BlockFunctionArgs = {
+    [BlockFunctionType.MAP]: {
+        expression: string;
+        targetFieldKey: string;
+        type: string;
+    };
+};

package/dist/blocks/functions/map/mapBlockFunction.d.ts

@@ -0,0 +1,2 @@
+import { BlockFunction } from '../../types';
+export declare const mapBlockFunction: BlockFunction;

package/dist/blocks/types.d.ts

@@ -0,0 +1,24 @@
+import { HttpResponse } from '@stackone/transport';
+import { BlockFunctionType } from './functions/functionsDirectoryTypes';
+export type Block = {
+    configs?: BlockFieldConfigs;
+    providerResponse?: HttpResponse;
+    result?: BlockIndexedRecord[] | BlockIndexedRecord;
+    context: BlockContext;
+};
+export type BlockContext = {
+    projectSecureId: string;
+    accountSecureId: string;
+    connector: string;
+    service: string;
+    resource: string;
+    operationType: string;
+};
+export type BlockFieldConfigs = {
+    [K in BlockFunctionType]?: unknown;
+};
+export type BlockIndexedRecord = {
+    id: string;
+    [key: string]: unknown;
+};
+export type BlockFunction = (block: Readonly<Block>) => Promise<Block>;

package/dist/index.d.ts

@@ -1,3 +1,7 @@
 export { IConnector, HttpOperations, HttpParameter, HttpParameterLocation, HttpParameterType, } from './types';
 export { BaseConnector } from './baseConnector';
 export { REQUEST_BODY_PARAM } from './constants';
+export { Block, BlockFunction, BlockIndexedRecord, BlockContext, BlockFieldConfigs, } from './blocks/types';
+export { BlockFunctionType } from './blocks/functions/functionsDirectoryTypes';
+export { blockPipe } from './blocks/blockPipe';
+export { getBlockPipeFunctionsFromConfig } from './blocks/blockFunctionsConfigs';

package/dist/index.es.mjs

@@ -1 +1 @@
-import{HttpClient as t}from"@stackone/transport";class e{constructor({version:e="1",key:r,name:s,services:o={},httpOperations:a={},auth:i,proxy:n,httpClient:h=new t}){this.listOperations=()=>Object.keys(this.httpOperations||{}),this.getOperation=t=>{const e=this.httpOperations?.[t];if(!e)throw new Error(`Operation ${t} not found`);return e},this.callOperation=async({operationId:t,params:e,credentials:r})=>{const s=this.httpOperations?.[t];if(!s)throw new Error(`Operation ${t} not found`);const o=(({params:t,httpOperation:e})=>{const{url:r,method:s}=e;let o=r;const a=[],i=[],n={};let h;Object.entries(t||{}).forEach((([t,r])=>{const s=e.parameters?.[t];if(s)switch(s.in){case"path":o=o.replace(`{${t}}`,r).replace(`:${t}`,r);break;case"query":a.push(`${t}=${r}`);break;case"header":n[t]=r;break;case"cookie":i.push(`${t}=${r}; `);break;case"body":h=r}}));const p=a.length>0?`?${a.join("&")}`:"";return i.length>0&&(n.cookie=i.join("")),{url:`${o}${p}`,method:s,headers:Object.keys(n).length>0?n:void 0,body:h||void 0}})({params:e,httpOperation:s}),{method:a,url:i,headers:n,body:h}=o,{apiKey:p}=r;return{connector:this,input:{operationId:t,params:e},response:await this.httpClient.request({method:a,url:i,headers:{...n,authorization:p},payload:h}),credentials:r}},this.version=e,this.key=r,this.name=s,this.services=o,this.httpOperations=a,this.auth=i,this.proxy=n,this.httpClient=h}}const r="request_body";export{e as BaseConnector,r as REQUEST_BODY_PARAM};
+import{HttpClient as t}from"@stackone/transport";const e=(t,r="")=>{if("object"===t.type&&t.properties){const s=""===r||r.endsWith(".")?r:`${r}.`;return Object.entries(t.properties).flatMap((([t,r])=>e(r,`${s}${t}`)))}return"array"===t.type&&t.items?e(t.items,`${r}[].`):[{name:r.endsWith(".")?r.slice(0,-1):r,type:t.type,description:t.description}]};class r{constructor({version:r="1",key:s,name:n,services:o={},httpOperations:i={},auth:a,proxy:c,httpClient:p=new t}){this.listOperations=()=>Object.keys(this.httpOperations||{}),this.getOperation=t=>{const e=this.httpOperations?.[t];if(!e)throw new Error(`Operation ${t} not found`);return e},this.getOperationResponseFieldsMetadata=t=>{const r=this.getOperation(t).responses;if(!r)return null;const s=(t=>{const e=Object.entries(t).find((([t])=>t.startsWith("2")));return e?e[1]:null})(r);return s&&s.content["application/json"]?.schema?e(s.content["application/json"]?.schema):null},this.callOperation=async({operationId:t,params:e,credentials:r})=>{const s=this.httpOperations?.[t];if(!s)throw new Error(`Operation ${t} not found`);const n=(({params:t,httpOperation:e})=>{const{url:r,method:s}=e;let n=r;const o=[],i=[],a={};let c;Object.entries(t||{}).forEach((([t,r])=>{const s=e.parameters?.[t];if(s)switch(s.in){case"path":n=n.replace(`{${t}}`,r).replace(`:${t}`,r);break;case"query":o.push(`${t}=${r}`);break;case"header":a[t]=r;break;case"cookie":i.push(`${t}=${r}; `);break;case"body":c=r}}));const p=o.length>0?`?${o.join("&")}`:"";return i.length>0&&(a.cookie=i.join("")),{url:`${n}${p}`,method:s,headers:Object.keys(a).length>0?a:void 0,body:c||void 0}})({params:e,httpOperation:s}),{method:o,url:i,headers:a,body:c}=n,{apiKey:p}=r;return{connector:this,input:{operationId:t,params:e},response:await this.httpClient.request({method:o,url:i,headers:{...a,authorization:p},payload:c}),credentials:r}},this.version=r,this.key=s,this.name=n,this.services=o,this.httpOperations=i,this.auth=a,this.proxy=c,this.httpClient=p}}const s="request_body";var n;!function(t){t.MAP="map"}(n||(n={}));const o=async(t,e)=>t.reduce((async(t,e)=>e(await t)),Promise.resolve(e)),i=async t=>{const e=t?.configs?.[n.MAP];if(!e)return t;let r;return r=Array.isArray(t.result)?t.result.map((r=>{const s=(t.providerResponse?.data?.[t.context.resource]).find((t=>t.id===r.id));return a(r,e,s)})):a(t.result,e,t.providerResponse?.data),{...t,result:r}},a=(t,e,r)=>{if(!r)return t;const s={...t};return e.forEach((t=>{const{expression:e,targetFieldKey:n}=t;r[e]&&(s[n]=r[e])})),{...s}};class c{static build(t){if(t===n.MAP)return i;throw new Error(`Unknown block function: ${t}`)}}const p=t=>Object.keys(t||{}).reduce(((t,e)=>{const r=c.build(e);return t.push(r),t}),[]);export{r as BaseConnector,n as BlockFunctionType,s as REQUEST_BODY_PARAM,o as blockPipe,p as getBlockPipeFunctionsFromConfig};

package/dist/index.js

@@ -1 +1 @@
-"use strict";var t=require("@stackone/transport");exports.BaseConnector=class{constructor({version:e="1",key:r,name:s,services:o={},httpOperations:a={},auth:i,proxy:n,httpClient:h=new t.HttpClient}){this.listOperations=()=>Object.keys(this.httpOperations||{}),this.getOperation=t=>{const e=this.httpOperations?.[t];if(!e)throw new Error(`Operation ${t} not found`);return e},this.callOperation=async({operationId:t,params:e,credentials:r})=>{const s=this.httpOperations?.[t];if(!s)throw new Error(`Operation ${t} not found`);const o=(({params:t,httpOperation:e})=>{const{url:r,method:s}=e;let o=r;const a=[],i=[],n={};let h;Object.entries(t||{}).forEach((([t,r])=>{const s=e.parameters?.[t];if(s)switch(s.in){case"path":o=o.replace(`{${t}}`,r).replace(`:${t}`,r);break;case"query":a.push(`${t}=${r}`);break;case"header":n[t]=r;break;case"cookie":i.push(`${t}=${r}; `);break;case"body":h=r}}));const p=a.length>0?`?${a.join("&")}`:"";return i.length>0&&(n.cookie=i.join("")),{url:`${o}${p}`,method:s,headers:Object.keys(n).length>0?n:void 0,body:h||void 0}})({params:e,httpOperation:s}),{method:a,url:i,headers:n,body:h}=o,{apiKey:p}=r;return{connector:this,input:{operationId:t,params:e},response:await this.httpClient.request({method:a,url:i,headers:{...n,authorization:p},payload:h}),credentials:r}},this.version=e,this.key=r,this.name=s,this.services=o,this.httpOperations=a,this.auth=i,this.proxy=n,this.httpClient=h}},exports.REQUEST_BODY_PARAM="request_body";
+"use strict";var t=require("@stackone/transport");const e=(t,r="")=>{if("object"===t.type&&t.properties){const s=""===r||r.endsWith(".")?r:`${r}.`;return Object.entries(t.properties).flatMap((([t,r])=>e(r,`${s}${t}`)))}return"array"===t.type&&t.items?e(t.items,`${r}[].`):[{name:r.endsWith(".")?r.slice(0,-1):r,type:t.type,description:t.description}]};exports.BlockFunctionType=void 0,(exports.BlockFunctionType||(exports.BlockFunctionType={})).MAP="map";const r=async t=>{const e=t?.configs?.[exports.BlockFunctionType.MAP];if(!e)return t;let r;return r=Array.isArray(t.result)?t.result.map((r=>{const n=(t.providerResponse?.data?.[t.context.resource]).find((t=>t.id===r.id));return s(r,e,n)})):s(t.result,e,t.providerResponse?.data),{...t,result:r}},s=(t,e,r)=>{if(!r)return t;const s={...t};return e.forEach((t=>{const{expression:e,targetFieldKey:n}=t;r[e]&&(s[n]=r[e])})),{...s}};class n{static build(t){if(t===exports.BlockFunctionType.MAP)return r;throw new Error(`Unknown block function: ${t}`)}}exports.BaseConnector=class{constructor({version:r="1",key:s,name:n,services:o={},httpOperations:i={},auth:a,proxy:c,httpClient:p=new t.HttpClient}){this.listOperations=()=>Object.keys(this.httpOperations||{}),this.getOperation=t=>{const e=this.httpOperations?.[t];if(!e)throw new Error(`Operation ${t} not found`);return e},this.getOperationResponseFieldsMetadata=t=>{const r=this.getOperation(t).responses;if(!r)return null;const s=(t=>{const e=Object.entries(t).find((([t])=>t.startsWith("2")));return e?e[1]:null})(r);return s&&s.content["application/json"]?.schema?e(s.content["application/json"]?.schema):null},this.callOperation=async({operationId:t,params:e,credentials:r})=>{const s=this.httpOperations?.[t];if(!s)throw new Error(`Operation ${t} not found`);const n=(({params:t,httpOperation:e})=>{const{url:r,method:s}=e;let n=r;const o=[],i=[],a={};let c;Object.entries(t||{}).forEach((([t,r])=>{const s=e.parameters?.[t];if(s)switch(s.in){case"path":n=n.replace(`{${t}}`,r).replace(`:${t}`,r);break;case"query":o.push(`${t}=${r}`);break;case"header":a[t]=r;break;case"cookie":i.push(`${t}=${r}; `);break;case"body":c=r}}));const p=o.length>0?`?${o.join("&")}`:"";return i.length>0&&(a.cookie=i.join("")),{url:`${n}${p}`,method:s,headers:Object.keys(a).length>0?a:void 0,body:c||void 0}})({params:e,httpOperation:s}),{method:o,url:i,headers:a,body:c}=n,{apiKey:p}=r;return{connector:this,input:{operationId:t,params:e},response:await this.httpClient.request({method:o,url:i,headers:{...a,authorization:p},payload:c}),credentials:r}},this.version=r,this.key=s,this.name=n,this.services=o,this.httpOperations=i,this.auth=a,this.proxy=c,this.httpClient=p}},exports.REQUEST_BODY_PARAM="request_body",exports.blockPipe=async(t,e)=>t.reduce((async(t,e)=>e(await t)),Promise.resolve(e)),exports.getBlockPipeFunctionsFromConfig=t=>Object.keys(t||{}).reduce(((t,e)=>{const r=n.build(e);return t.push(r),t}),[]);

package/dist/responseMetaData.d.ts

@@ -0,0 +1,3 @@
+import { HttpParameterSchema, HttpResponses, HttpSchemaResponse, ResponseFieldMetaData } from './types';
+export declare const getSuccessfulResponse: (responses: HttpResponses) => HttpSchemaResponse | null;
+export declare const getResponseFieldsMetaData: (schema: HttpParameterSchema, parentFieldKey?: string) => ResponseFieldMetaData[];

package/dist/types.d.ts

@@ -38,12 +38,37 @@ export interface HttpParameter {
     type: HttpParameterType;
     isArray?: boolean;
 }
+export type HttpResponses = {
+    [key: string]: HttpSchemaResponse;
+};
+export type HttpSchemaResponse = {
+    description: string;
+    content: {
+        [key: string]: {
+            schema: HttpParameterSchema;
+        };
+    };
+};
+export type HttpParameterSchema = {
+    type: string;
+    description?: string;
+    properties?: {
+        [key: string]: HttpParameterSchema;
+    };
+    items?: HttpParameterSchema;
+};
+export type ResponseFieldMetaData = {
+    name: string;
+    type: HttpParameterType;
+    description?: string;
+};
 export type HttpOperation = {
     url: string;
     method: HttpMethod;
     parameters?: {
         [key: string]: HttpParameter;
     };
+    responses: HttpResponses;
 };
 export type HttpOperations = {
     [key: string]: HttpOperation;

package/package.json

@@ -1,10 +1,10 @@
 {
     "name": "@stackone/core",
-    "version": "1.0.0",
+    "version": "1.2.0",
     "description": "",
     "main": "dist/index.js",
     "module": "dist/index.es.js",
-    "types": "dist/index.d.ts",
+    "types": "dist/types/index.d.ts",
     "files": [
         "dist",
         "package.json",
@@ -18,7 +18,7 @@
         "lint:fix": "npm run lint -- --fix",
         "test": "vitest run",
         "test:watch": "vitest watch",
-        "publish": "npm publish --access=public"
+        "publish-release": "npm publish --access=public"
     },
     "keywords": [],
     "author": "StackOne",