@stackone/core 1.0.0

package/README.md

@@ -0,0 +1,50 @@
+# @stackone/open-api
+
+## Description
+
+This package contains all the core functionalities and abstractions used by StackOne products.
+
+This package uses the tech stack provided by the **Connect Monorepo** global setup. Please check the [root README](../../README.md) for more information.
+
+## Requirements
+
+Please check the [root README](../../README.md) for requirements.
+
+## Installation
+
+```bash
+# install dependencies
+$ npm run install
+```
+
+## Available commands
+
+```bash
+# clean build output
+$ npm run clean
+```
+
+```bash
+# build package
+$ npm run build
+```
+
+```bash
+# run tests
+$ npm run test
+```
+
+```bash
+# run tests on watch mode
+$ npm run test:watch
+```
+
+```bash
+# run linter
+$ npm run lint
+```
+
+```bash
+# run linter and try to fix any error
+$ npm run lint:fix
+```

package/dist/baseConnector.d.ts

@@ -0,0 +1,39 @@
+import { IHttpClient } from '@stackone/transport';
+import { Bundle, HttpOperation, HttpOperations, IConnector, Operation, Service } from './types';
+export declare abstract class BaseConnector implements IConnector {
+    protected httpClient: IHttpClient;
+    version: string;
+    key: string;
+    name: string;
+    services: {
+        ats?: Service | undefined;
+        crm?: Service | undefined;
+        hris?: Service | undefined;
+        marketing?: Service | undefined;
+    };
+    httpOperations?: HttpOperations;
+    auth?: unknown;
+    proxy?: Operation;
+    constructor({ version, key, name, services, httpOperations, auth, proxy, httpClient, }: {
+        version?: string;
+        key: string;
+        name: string;
+        services?: {
+            ats?: Service | undefined;
+            crm?: Service | undefined;
+            hris?: Service | undefined;
+            marketing?: Service | undefined;
+        };
+        httpOperations?: HttpOperations;
+        auth?: unknown;
+        proxy?: Operation;
+        httpClient?: IHttpClient;
+    });
+    listOperations: () => string[];
+    getOperation: (operationId: string) => HttpOperation;
+    callOperation: ({ operationId, params, credentials, }: {
+        operationId: string;
+        params?: Record<string, unknown> | undefined;
+        credentials?: unknown;
+    }) => Promise<Bundle>;
+}

package/dist/constants.d.ts

@@ -0,0 +1 @@
+export declare const REQUEST_BODY_PARAM = "request_body";

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { IConnector, HttpOperations, HttpParameter, HttpParameterLocation, HttpParameterType, } from './types';
+export { BaseConnector } from './baseConnector';
+export { REQUEST_BODY_PARAM } from './constants';

package/dist/index.es.mjs

@@ -0,0 +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};

package/dist/index.js

@@ -0,0 +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";

package/dist/mappers.d.ts

@@ -0,0 +1,11 @@
+import { HttpMethod } from '@stackone/transport';
+import { HttpOperation } from './types';
+export declare const mapParametersToHttpRequest: ({ params, httpOperation, }: {
+    params?: Record<string, unknown> | undefined;
+    httpOperation: HttpOperation;
+}) => {
+    url: string;
+    method: HttpMethod;
+    headers?: Record<string, unknown> | undefined;
+    body?: Record<string, unknown> | undefined;
+};

package/dist/types.d.ts

@@ -0,0 +1,64 @@
+import { IHttpClient, HttpResponse, HttpMethod } from '@stackone/transport';
+export type RequestParameters = {
+    id?: string | number;
+    body?: Record<string, unknown>;
+    [key: string]: unknown;
+};
+export type Operation = ({ input, credentials, getHttpClient, }: {
+    input: RequestParameters;
+    credentials?: unknown;
+    getHttpClient?: () => Promise<IHttpClient>;
+}) => Promise<Bundle>;
+export interface Resource {
+    [key: string]: Operation | Resource;
+}
+export interface Service {
+    [key: string]: Resource;
+}
+export type Bundle = {
+    connector: IConnector;
+    input: RequestParameters;
+    credentials: unknown;
+    url?: string;
+    response?: HttpResponse;
+};
+export type AuthenticationConfig = {
+    [authentication: string]: Environment;
+};
+export type Environment = {
+    default: AuthenticationConfig;
+    production: AuthenticationConfig;
+} & {
+    [environment: string]: AuthenticationConfig;
+};
+export type HttpParameterLocation = 'path' | 'query' | 'header' | 'cookie' | 'body';
+export type HttpParameterType = 'boolean' | 'object' | 'number' | 'string' | 'integer';
+export interface HttpParameter {
+    in: HttpParameterLocation;
+    type: HttpParameterType;
+    isArray?: boolean;
+}
+export type HttpOperation = {
+    url: string;
+    method: HttpMethod;
+    parameters?: {
+        [key: string]: HttpParameter;
+    };
+};
+export type HttpOperations = {
+    [key: string]: HttpOperation;
+};
+export interface IConnector {
+    version: string;
+    key: string;
+    name: string;
+    services: {
+        ats?: Service;
+        crm?: Service;
+        hris?: Service;
+        marketing?: Service;
+    };
+    httpOperations?: HttpOperations;
+    auth?: unknown;
+    proxy?: Operation;
+}

package/package.json

@@ -0,0 +1,29 @@
+{
+    "name": "@stackone/core",
+    "version": "1.0.0",
+    "description": "",
+    "main": "dist/index.js",
+    "module": "dist/index.es.js",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist",
+        "package.json",
+        "README.md"
+    ],
+    "scripts": {
+        "clean": "rimraf dist",
+        "prebuild": "npm run clean",
+        "build": "rollup -c",
+        "lint": "tsc --project tsconfig.json && eslint \"src/**/*.ts\"",
+        "lint:fix": "npm run lint -- --fix",
+        "test": "vitest run",
+        "test:watch": "vitest watch",
+        "publish": "npm publish --access=public"
+    },
+    "keywords": [],
+    "author": "StackOne",
+    "license": "ISC",
+    "dependencies": {
+        "@stackone/transport": "*"
+    }
+}