@xylabs/api 4.13.19 → 4.13.21

package/README.md

@@ -12,13 +12,274 @@
 [![snyk-badge][]][snyk-link]
 [![socket-badge][]][socket-link]
 
-Version: 4.13.15
 
 Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
-## Documentation
+## API Documentation
+
+**@xylabs/api**
+
+***
+
+## Classes
+
+- [ApiClient](#classes/ApiClient)
+- [ApiEndpoint](#classes/ApiEndpoint)
+
+## Interfaces
+
+- [ApiConfig](#interfaces/ApiConfig)
+
+## Type Aliases
+
+- [ApiStage](#type-aliases/ApiStage)
+
+## Variables
+
+- [ApiStage](#variables/ApiStage)
+
+## Functions
+
+- [getApiStage](#functions/getApiStage)
+
+### classes
+
+  ### <a id="ApiClient"></a>ApiClient
+
+[**@xylabs/api**](#../README)
+
+***
+
+## Constructors
+
+### Constructor
+
+```ts
+new ApiClient(token?, stage?): ApiClient;
+```
+
+### Parameters
+
+#### token?
+
+`null` | `string`
+
+#### stage?
+
+[`ApiStage`](#../type-aliases/ApiStage)
+
+### Returns
+
+`ApiClient`
+
+## Properties
+
+### token?
+
+```ts
+protected optional token: null | string;
+```
+
+***
+
+### stage?
+
+```ts
+protected optional stage: ApiStage;
+```
+
+## Methods
+
+### endPoint()
+
+```ts
+abstract endPoint(): string;
+```
+
+### Returns
+
+`string`
+
+  ### <a id="ApiEndpoint"></a>ApiEndpoint
+
+[**@xylabs/api**](#../README)
+
+***
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Constructors
+
+### Constructor
+
+```ts
+new ApiEndpoint<T>(config, path): ApiEndpoint<T>;
+```
+
+### Parameters
+
+#### config
+
+[`ApiConfig`](#../interfaces/ApiConfig)
+
+#### path
+
+`string`
+
+### Returns
+
+`ApiEndpoint`\<`T`\>
+
+## Accessors
+
+### value
+
+### Get Signature
+
+```ts
+get value(): undefined | T;
+```
+
+#### Returns
+
+`undefined` \| `T`
+
+## Methods
+
+### fetch()
+
+```ts
+fetch(): Promise<T>;
+```
+
+### Returns
+
+`Promise`\<`T`\>
+
+***
+
+### get()
+
+```ts
+get(): Promise<T | NonNullable<T>>;
+```
+
+### Returns
+
+`Promise`\<`T` \| `NonNullable`\<`T`\>\>
+
+***
+
+### insert()
+
+```ts
+insert(value): Promise<T>;
+```
+
+### Parameters
+
+#### value
+
+`T`
+
+### Returns
+
+`Promise`\<`T`\>
+
+### functions
+
+  ### <a id="getApiStage"></a>getApiStage
+
+[**@xylabs/api**](#../README)
+
+***
+
+```ts
+function getApiStage(hostname): "beta" | "local" | "prod";
+```
+
+## Parameters
+
+### hostname
+
+`string`
+
+## Returns
+
+`"beta"` \| `"local"` \| `"prod"`
+
+### interfaces
+
+  ### <a id="ApiConfig"></a>ApiConfig
+
+[**@xylabs/api**](#../README)
+
+***
+
+## Properties
+
+### apiDomain
+
+```ts
+apiDomain: string;
+```
+
+***
+
+### apiKey?
+
+```ts
+optional apiKey: string;
+```
+
+***
+
+### jwtToken?
+
+```ts
+optional jwtToken: string;
+```
+
+***
+
+### userid?
+
+```ts
+optional userid: string;
+```
+
+### type-aliases
+
+  ### <a id="ApiStage"></a>ApiStage
+
+[**@xylabs/api**](#../README)
+
+***
+
+```ts
+type ApiStage = EnumValue<typeof ApiStage>;
+```
+
+### variables
+
+  ### <a id="ApiStage"></a>ApiStage
+
+[**@xylabs/api**](#../README)
+
+***
+
+```ts
+const ApiStage: Enum<{
+  Beta: "beta";
+  Local: "local";
+  Prod: "prod";
+}>;
+```
 
-Coming Soon!
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/api",
-  "version": "4.13.19",
+  "version": "4.13.21",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "xylabs",
@@ -28,23 +28,26 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
+      "source": "./src/index.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "./dist/neutral/index.mjs",
+  "source": "./src/index.ts",
   "types": "./dist/neutral/index.d.ts",
-  "workspaces": [
-    "packages/**/*"
+  "files": [
+    "dist",
+    "src"
   ],
   "dependencies": {
-    "@xylabs/enum": "^4.13.19",
-    "@xylabs/typeof": "^4.13.19",
+    "@xylabs/enum": "^4.13.21",
+    "@xylabs/typeof": "^4.13.21",
     "axios": "^1.10.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
-    "@xylabs/tsconfig": "^7.0.0-rc.27",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0",
+    "@xylabs/tsconfig": "^7.0.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/src/spec/ApiEndpoint.spec.ts

@@ -0,0 +1,12 @@
+import {
+  describe, expect, test,
+} from 'vitest'
+
+import { ApiEndpoint } from '../ApiEndpoint.ts'
+
+describe('ApiEndpoint', () => {
+  test('checking happy path', () => {
+    const apiEndpoint = new ApiEndpoint({ apiDomain: 'sample.com' }, '/')
+    expect(apiEndpoint).toBeDefined()
+  })
+})

package/src/spec/getApiStage.spec.ts

@@ -0,0 +1,12 @@
+import {
+  describe, expect, test,
+} from 'vitest'
+
+import { getApiStage } from '../getApiStage.ts'
+
+describe('getApiStage', () => {
+  test('checking happy path', () => {
+    const apiStage = getApiStage('localhost')
+    expect(apiStage).toBeDefined()
+  })
+})

package/xy.config.ts

@@ -1,10 +0,0 @@
-import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
-const config: XyTsupConfig = {
-  compile: {
-    browser: {},
-    neutral: { src: true },
-    node: {},
-  },
-}
-
-export default config