Merge pull request #20 from code-store-platform/feat/add-custom-request

Add custom request function to ArcAPI

Author: msadovyi

CHANGELOG.md

@@ -1,5 +1,11 @@
 # @code.store/arcxp-sdk-ts
 
+## 4.48.0
+
+### Minor Changes
+
+- Add custom request function to ArcAPI
+
 ## 4.47.2
 
 ### Patch Changes

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code.store/arcxp-sdk-ts",
-  "version": "4.47.2",
+  "version": "4.48.0",
   "description": "A strongly typed set of ArcXP API's and utilities reduce the amount of work required to develop with ArcXP, starting with reducing the boilerplate code you have to write.",
   "type": "commonjs",
   "main": "./dist/index.js",
@@ -13,9 +13,7 @@
     "url": "https://github.com/code-store-platform/arcxp-sdk-ts"
   },
   "homepage": "https://github.com/code-store-platform/arcxp-sdk-ts",
-  "files": [
-    "dist"
-  ],
+  "files": ["dist"],
   "scripts": {
     "build": "tsc",
     "format": "npx @biomejs/biome format --write .",
@@ -27,11 +25,7 @@
     "cs": "npx changeset && npx changeset version",
     "swaggerToTypes": "npx swagger-typescript-api -p ./tmp/swagger.json -o ./tmp -n swaggerTypes.ts"
   },
-  "keywords": [
-    "ArcXP",
-    "SDK",
-    "Code.Store"
-  ],
+  "keywords": ["ArcXP", "SDK", "Code.Store"],
   "author": "code.store",
   "license": "MIT",
   "dependencies": {

src/api/custom/index.ts

@@ -0,0 +1,22 @@
+import type { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api';
+
+export interface RequestConfig extends AxiosRequestConfig {}
+
+export class Custom extends ArcAbstractAPI {
+  constructor(options: ArcAPIOptions) {
+    super({ ...options, apiPath: '' });
+  }
+
+  public async request<T = unknown>(
+    endpoint: `/${string}`,
+    config: AxiosRequestConfig = {}
+  ): Promise<AxiosResponse<T>> {
+    const response: AxiosResponse<T> = await this.client.request<T>({
+      url: endpoint,
+      ...config,
+    });
+
+    return response;
+  }
+}

src/api/draft/index.ts

@@ -1,4 +1,4 @@
-import { AStory } from '../../types/story';
+import type { AStory } from '../../types/story';
 import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api';
 import type {
   Circulations,

src/api/index.ts

@@ -2,6 +2,7 @@ import type { ArcAPIOptions } from './abstract-api';
 import { ArcAuthor } from './author';
 import { ArcContent } from './content';
 import { ArcContentOps } from './content-ops';
+import { Custom } from './custom';
 import { ArcDraft } from './draft';
 import { GlobalSettings } from './global-settings';
 import { ArcIdentity } from './identity';
@@ -33,6 +34,7 @@ export const ArcAPI = (options: ArcAPIOptions) => {
     GlobalSettings: new GlobalSettings(options),
     Tags: new ArcTags(options),
     ContentOps: new ArcContentOps(options),
+    Custom: new Custom(options),
   };
 
   return {