@xylabs/api 5.0.83 → 5.0.84

package/README.md

@@ -50,6 +50,8 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ***
 
+Abstract base class for API clients that provides stage and token configuration.
+
 ## Constructors
 
 ### Constructor
@@ -106,12 +108,16 @@ abstract endPoint(): string;
 
 ***
 
+Generic REST API endpoint wrapper that supports fetching and inserting typed data.
+
 ## Type Parameters
 
 ### T
 
 `T`
 
+The type of data returned by the endpoint
+
 ## Constructors
 
 ### Constructor
@@ -202,16 +208,22 @@ insert(value): Promise<T>;
 function getApiStage(hostname): "beta" | "local" | "prod";
 ```
 
+Determines the API stage based on the hostname.
+
 ## Parameters
 
 ### hostname
 
 `string`
 
+The hostname to evaluate
+
 ## Returns
 
 `"beta"` \| `"local"` \| `"prod"`
 
+The corresponding ApiStage (Local, Beta, or Prod)
+
 ### interfaces
 
   ### <a id="ApiConfig"></a>ApiConfig
@@ -220,6 +232,8 @@ function getApiStage(hostname): "beta" | "local" | "prod";
 
 ***
 
+Configuration for connecting to an API, including domain, authentication, and user identification.
+
 ## Properties
 
 ### apiDomain
@@ -264,6 +278,8 @@ optional userid: string;
 type ApiStage = EnumValue<typeof ApiStage>;
 ```
 
+A valid API stage value ('prod', 'beta', or 'local').
+
 ### variables
 
   ### <a id="ApiStage"></a>ApiStage
@@ -280,6 +296,8 @@ const ApiStage: Enum<{
 }>;
 ```
 
+Deployment stage identifiers for API environments.
+
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 

package/dist/neutral/ApiClient.d.ts

@@ -1,4 +1,5 @@
 import { ApiStage } from './ApiStage.ts';
+/** Abstract base class for API clients that provides stage and token configuration. */
 declare abstract class ApiClient {
     protected stage?: ApiStage;
     protected token?: string | null;

package/dist/neutral/ApiClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ApiClient.d.ts","sourceRoot":"","sources":["../../src/ApiClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAExC,uBAAe,SAAS;IACtB,SAAS,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAA;IAC1B,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;gBAG7B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,EACrB,KAAK,CAAC,EAAE,QAAQ;IAMlB,QAAQ,CAAC,QAAQ,IAAI,MAAM;CAC5B;AAED,OAAO,EAAE,SAAS,EAAE,CAAA"}
+{"version":3,"file":"ApiClient.d.ts","sourceRoot":"","sources":["../../src/ApiClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAExC,uFAAuF;AACvF,uBAAe,SAAS;IACtB,SAAS,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAA;IAC1B,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;gBAG7B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,EACrB,KAAK,CAAC,EAAE,QAAQ;IAMlB,QAAQ,CAAC,QAAQ,IAAI,MAAM;CAC5B;AAED,OAAO,EAAE,SAAS,EAAE,CAAA"}

package/dist/neutral/ApiConfig.d.ts

@@ -1,3 +1,4 @@
+/** Configuration for connecting to an API, including domain, authentication, and user identification. */
 interface ApiConfig {
     apiDomain: string;
     apiKey?: string;

package/dist/neutral/ApiConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ApiConfig.d.ts","sourceRoot":"","sources":["../../src/ApiConfig.ts"],"names":[],"mappings":"AAAA,UAAU,SAAS;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,YAAY,EAAE,SAAS,EAAE,CAAA"}
+{"version":3,"file":"ApiConfig.d.ts","sourceRoot":"","sources":["../../src/ApiConfig.ts"],"names":[],"mappings":"AAAA,yGAAyG;AACzG,UAAU,SAAS;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,YAAY,EAAE,SAAS,EAAE,CAAA"}

package/dist/neutral/ApiEndpoint.d.ts

@@ -1,4 +1,8 @@
 import type { ApiConfig } from './ApiConfig.ts';
+/**
+ * Generic REST API endpoint wrapper that supports fetching and inserting typed data.
+ * @typeParam T - The type of data returned by the endpoint
+ */
 declare class ApiEndpoint<T> {
     private _value?;
     private config;

package/dist/neutral/ApiEndpoint.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ApiEndpoint.d.ts","sourceRoot":"","sources":["../../src/ApiEndpoint.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE/C,cAAM,WAAW,CAAC,CAAC;IACjB,OAAO,CAAC,MAAM,CAAC,CAAG;IAClB,OAAO,CAAC,MAAM,CAAW;IACzB,OAAO,CAAC,IAAI,CAAQ;gBAER,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM;IAK3C,IAAI,KAAK,kBAER;IAED,OAAO,KAAK,OAAO,GAElB;IAED,OAAO,KAAK,GAAG,GAEd;IAEK,KAAK;IAUL,GAAG;IAIH,MAAM,CAAC,KAAK,EAAE,CAAC;CAStB;AAED,OAAO,EAAE,WAAW,EAAE,CAAA"}
+{"version":3,"file":"ApiEndpoint.d.ts","sourceRoot":"","sources":["../../src/ApiEndpoint.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE/C;;;GAGG;AACH,cAAM,WAAW,CAAC,CAAC;IACjB,OAAO,CAAC,MAAM,CAAC,CAAG;IAClB,OAAO,CAAC,MAAM,CAAW;IACzB,OAAO,CAAC,IAAI,CAAQ;gBAER,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM;IAK3C,IAAI,KAAK,kBAER;IAED,OAAO,KAAK,OAAO,GAElB;IAED,OAAO,KAAK,GAAG,GAEd;IAEK,KAAK;IAUL,GAAG;IAIH,MAAM,CAAC,KAAK,EAAE,CAAC;CAStB;AAED,OAAO,EAAE,WAAW,EAAE,CAAA"}

package/dist/neutral/ApiStage.d.ts

@@ -1,9 +1,11 @@
 import type { EnumValue } from '@xylabs/enum';
 import { Enum } from '@xylabs/enum';
+/** Deployment stage identifiers for API environments. */
 export declare const ApiStage: Enum<{
     Beta: "beta";
     Local: "local";
     Prod: "prod";
 }>;
+/** A valid API stage value ('prod', 'beta', or 'local'). */
 export type ApiStage = EnumValue<typeof ApiStage>;
 //# sourceMappingURL=ApiStage.d.ts.map

package/dist/neutral/ApiStage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ApiStage.d.ts","sourceRoot":"","sources":["../../src/ApiStage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAEnC,eAAO,MAAM,QAAQ;;;;EAInB,CAAA;AAEF,MAAM,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,QAAQ,CAAC,CAAA"}
+{"version":3,"file":"ApiStage.d.ts","sourceRoot":"","sources":["../../src/ApiStage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAEnC,yDAAyD;AACzD,eAAO,MAAM,QAAQ;;;;EAInB,CAAA;AAEF,4DAA4D;AAC5D,MAAM,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,QAAQ,CAAC,CAAA"}

package/dist/neutral/getApiStage.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Determines the API stage based on the hostname.
+ * @param hostname - The hostname to evaluate
+ * @returns The corresponding ApiStage (Local, Beta, or Prod)
+ */
 declare const getApiStage: (hostname: string) => "beta" | "local" | "prod";
 export { getApiStage };
 //# sourceMappingURL=getApiStage.d.ts.map

package/dist/neutral/getApiStage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getApiStage.d.ts","sourceRoot":"","sources":["../../src/getApiStage.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,WAAW,GAAI,UAAU,MAAM,8BAQpC,CAAA;AAED,OAAO,EAAE,WAAW,EAAE,CAAA"}
+{"version":3,"file":"getApiStage.d.ts","sourceRoot":"","sources":["../../src/getApiStage.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,QAAA,MAAM,WAAW,GAAI,UAAU,MAAM,8BAQpC,CAAA;AAED,OAAO,EAAE,WAAW,EAAE,CAAA"}

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/ApiStage.ts","../../src/ApiClient.ts","../../src/ApiEndpoint.ts","../../src/getApiStage.ts"],"sourcesContent":["import type { EnumValue } from '@xylabs/enum'\nimport { Enum } from '@xylabs/enum'\n\nexport const ApiStage = Enum({\n  Beta: 'beta',\n  Local: 'local',\n  Prod: 'prod',\n})\n\nexport type ApiStage = EnumValue<typeof ApiStage>\n","import { ApiStage } from './ApiStage.ts'\n\nabstract class ApiClient {\n  protected stage?: ApiStage\n  protected token?: string | null\n\n  constructor(\n    token?: string | null,\n    stage?: ApiStage,\n  ) {\n    this.stage = stage ?? ApiStage.Prod\n    this.token = token\n  }\n\n  abstract endPoint(): string\n}\n\nexport { ApiClient }\n","import { isUndefined } from '@xylabs/typeof'\nimport axios from 'axios'\n\nimport type { ApiConfig } from './ApiConfig.ts'\n\nclass ApiEndpoint<T> {\n  private _value?: T\n  private config: ApiConfig\n  private path: string\n\n  constructor(config: ApiConfig, path: string) {\n    this.config = config\n    this.path = path\n  }\n\n  get value() {\n    return this._value\n  }\n\n  private get headers() {\n    return isUndefined(this.config.jwtToken) ? undefined : { Authorization: this.config.jwtToken }\n  }\n\n  private get url() {\n    return `${this.config.apiDomain}/${this.path}`\n  }\n\n  async fetch() {\n    const response = await axios.get<T>(this.url, { headers: this.headers })\n    if (response.status === 200) {\n      this._value = response.data\n    } else {\n      throw new Error('Unexpected Status Code')\n    }\n    return this._value\n  }\n\n  async get() {\n    return this._value ?? (await this.fetch())\n  }\n\n  async insert(value: T) {\n    const response = await axios.post<T>(this.url, value, { headers: this.headers })\n    if (response.status === 200) {\n      this._value = response.data\n    } else {\n      throw new Error('Unexpected Status Code')\n    }\n    return this._value\n  }\n}\n\nexport { ApiEndpoint }\n","import { ApiStage } from './ApiStage.ts'\n\nconst getApiStage = (hostname: string) => {\n  if (hostname.startsWith('localhost')) {\n    return ApiStage.Local\n  } else if (hostname.startsWith('beta.')) {\n    return ApiStage.Beta\n  } else {\n    return ApiStage.Prod\n  }\n}\n\nexport { getApiStage }\n"],"mappings":";AACA,SAAS,YAAY;AAEd,IAAM,WAAW,KAAK;AAAA,EAC3B,MAAM;AAAA,EACN,OAAO;AAAA,EACP,MAAM;AACR,CAAC;;;ACLD,IAAe,YAAf,MAAyB;AAAA,EACb;AAAA,EACA;AAAA,EAEV,YACE,OACA,OACA;AACA,SAAK,QAAQ,SAAS,SAAS;AAC/B,SAAK,QAAQ;AAAA,EACf;AAGF;;;ACfA,SAAS,mBAAmB;AAC5B,OAAO,WAAW;AAIlB,IAAM,cAAN,MAAqB;AAAA,EACX;AAAA,EACA;AAAA,EACA;AAAA,EAER,YAAY,QAAmB,MAAc;AAC3C,SAAK,SAAS;AACd,SAAK,OAAO;AAAA,EACd;AAAA,EAEA,IAAI,QAAQ;AACV,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAY,UAAU;AACpB,WAAO,YAAY,KAAK,OAAO,QAAQ,IAAI,SAAY,EAAE,eAAe,KAAK,OAAO,SAAS;AAAA,EAC/F;AAAA,EAEA,IAAY,MAAM;AAChB,WAAO,GAAG,KAAK,OAAO,SAAS,IAAI,KAAK,IAAI;AAAA,EAC9C;AAAA,EAEA,MAAM,QAAQ;AACZ,UAAM,WAAW,MAAM,MAAM,IAAO,KAAK,KAAK,EAAE,SAAS,KAAK,QAAQ,CAAC;AACvE,QAAI,SAAS,WAAW,KAAK;AAC3B,WAAK,SAAS,SAAS;AAAA,IACzB,OAAO;AACL,YAAM,IAAI,MAAM,wBAAwB;AAAA,IAC1C;AACA,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,MAAM,MAAM;AACV,WAAO,KAAK,UAAW,MAAM,KAAK,MAAM;AAAA,EAC1C;AAAA,EAEA,MAAM,OAAO,OAAU;AACrB,UAAM,WAAW,MAAM,MAAM,KAAQ,KAAK,KAAK,OAAO,EAAE,SAAS,KAAK,QAAQ,CAAC;AAC/E,QAAI,SAAS,WAAW,KAAK;AAC3B,WAAK,SAAS,SAAS;AAAA,IACzB,OAAO;AACL,YAAM,IAAI,MAAM,wBAAwB;AAAA,IAC1C;AACA,WAAO,KAAK;AAAA,EACd;AACF;;;AChDA,IAAM,cAAc,CAAC,aAAqB;AACxC,MAAI,SAAS,WAAW,WAAW,GAAG;AACpC,WAAO,SAAS;AAAA,EAClB,WAAW,SAAS,WAAW,OAAO,GAAG;AACvC,WAAO,SAAS;AAAA,EAClB,OAAO;AACL,WAAO,SAAS;AAAA,EAClB;AACF;","names":[]}
+{"version":3,"sources":["../../src/ApiStage.ts","../../src/ApiClient.ts","../../src/ApiEndpoint.ts","../../src/getApiStage.ts"],"sourcesContent":["import type { EnumValue } from '@xylabs/enum'\nimport { Enum } from '@xylabs/enum'\n\n/** Deployment stage identifiers for API environments. */\nexport const ApiStage = Enum({\n  Beta: 'beta',\n  Local: 'local',\n  Prod: 'prod',\n})\n\n/** A valid API stage value ('prod', 'beta', or 'local'). */\nexport type ApiStage = EnumValue<typeof ApiStage>\n","import { ApiStage } from './ApiStage.ts'\n\n/** Abstract base class for API clients that provides stage and token configuration. */\nabstract class ApiClient {\n  protected stage?: ApiStage\n  protected token?: string | null\n\n  constructor(\n    token?: string | null,\n    stage?: ApiStage,\n  ) {\n    this.stage = stage ?? ApiStage.Prod\n    this.token = token\n  }\n\n  abstract endPoint(): string\n}\n\nexport { ApiClient }\n","import { isUndefined } from '@xylabs/typeof'\nimport axios from 'axios'\n\nimport type { ApiConfig } from './ApiConfig.ts'\n\n/**\n * Generic REST API endpoint wrapper that supports fetching and inserting typed data.\n * @typeParam T - The type of data returned by the endpoint\n */\nclass ApiEndpoint<T> {\n  private _value?: T\n  private config: ApiConfig\n  private path: string\n\n  constructor(config: ApiConfig, path: string) {\n    this.config = config\n    this.path = path\n  }\n\n  get value() {\n    return this._value\n  }\n\n  private get headers() {\n    return isUndefined(this.config.jwtToken) ? undefined : { Authorization: this.config.jwtToken }\n  }\n\n  private get url() {\n    return `${this.config.apiDomain}/${this.path}`\n  }\n\n  async fetch() {\n    const response = await axios.get<T>(this.url, { headers: this.headers })\n    if (response.status === 200) {\n      this._value = response.data\n    } else {\n      throw new Error('Unexpected Status Code')\n    }\n    return this._value\n  }\n\n  async get() {\n    return this._value ?? (await this.fetch())\n  }\n\n  async insert(value: T) {\n    const response = await axios.post<T>(this.url, value, { headers: this.headers })\n    if (response.status === 200) {\n      this._value = response.data\n    } else {\n      throw new Error('Unexpected Status Code')\n    }\n    return this._value\n  }\n}\n\nexport { ApiEndpoint }\n","import { ApiStage } from './ApiStage.ts'\n\n/**\n * Determines the API stage based on the hostname.\n * @param hostname - The hostname to evaluate\n * @returns The corresponding ApiStage (Local, Beta, or Prod)\n */\nconst getApiStage = (hostname: string) => {\n  if (hostname.startsWith('localhost')) {\n    return ApiStage.Local\n  } else if (hostname.startsWith('beta.')) {\n    return ApiStage.Beta\n  } else {\n    return ApiStage.Prod\n  }\n}\n\nexport { getApiStage }\n"],"mappings":";AACA,SAAS,YAAY;AAGd,IAAM,WAAW,KAAK;AAAA,EAC3B,MAAM;AAAA,EACN,OAAO;AAAA,EACP,MAAM;AACR,CAAC;;;ACLD,IAAe,YAAf,MAAyB;AAAA,EACb;AAAA,EACA;AAAA,EAEV,YACE,OACA,OACA;AACA,SAAK,QAAQ,SAAS,SAAS;AAC/B,SAAK,QAAQ;AAAA,EACf;AAGF;;;AChBA,SAAS,mBAAmB;AAC5B,OAAO,WAAW;AAQlB,IAAM,cAAN,MAAqB;AAAA,EACX;AAAA,EACA;AAAA,EACA;AAAA,EAER,YAAY,QAAmB,MAAc;AAC3C,SAAK,SAAS;AACd,SAAK,OAAO;AAAA,EACd;AAAA,EAEA,IAAI,QAAQ;AACV,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAY,UAAU;AACpB,WAAO,YAAY,KAAK,OAAO,QAAQ,IAAI,SAAY,EAAE,eAAe,KAAK,OAAO,SAAS;AAAA,EAC/F;AAAA,EAEA,IAAY,MAAM;AAChB,WAAO,GAAG,KAAK,OAAO,SAAS,IAAI,KAAK,IAAI;AAAA,EAC9C;AAAA,EAEA,MAAM,QAAQ;AACZ,UAAM,WAAW,MAAM,MAAM,IAAO,KAAK,KAAK,EAAE,SAAS,KAAK,QAAQ,CAAC;AACvE,QAAI,SAAS,WAAW,KAAK;AAC3B,WAAK,SAAS,SAAS;AAAA,IACzB,OAAO;AACL,YAAM,IAAI,MAAM,wBAAwB;AAAA,IAC1C;AACA,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,MAAM,MAAM;AACV,WAAO,KAAK,UAAW,MAAM,KAAK,MAAM;AAAA,EAC1C;AAAA,EAEA,MAAM,OAAO,OAAU;AACrB,UAAM,WAAW,MAAM,MAAM,KAAQ,KAAK,KAAK,OAAO,EAAE,SAAS,KAAK,QAAQ,CAAC;AAC/E,QAAI,SAAS,WAAW,KAAK;AAC3B,WAAK,SAAS,SAAS;AAAA,IACzB,OAAO;AACL,YAAM,IAAI,MAAM,wBAAwB;AAAA,IAC1C;AACA,WAAO,KAAK;AAAA,EACd;AACF;;;AC/CA,IAAM,cAAc,CAAC,aAAqB;AACxC,MAAI,SAAS,WAAW,WAAW,GAAG;AACpC,WAAO,SAAS;AAAA,EAClB,WAAW,SAAS,WAAW,OAAO,GAAG;AACvC,WAAO,SAAS;AAAA,EAClB,OAAO;AACL,WAAO,SAAS;AAAA,EAClB;AACF;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/api",
-  "version": "5.0.83",
+  "version": "5.0.84",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "xylabs",
@@ -41,12 +41,12 @@
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/enum": "~5.0.83",
-    "@xylabs/typeof": "~5.0.83"
+    "@xylabs/enum": "~5.0.84",
+    "@xylabs/typeof": "~5.0.84"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "~7.4.11",
-    "@xylabs/tsconfig": "~7.4.11",
+    "@xylabs/ts-scripts-yarn3": "~7.4.13",
+    "@xylabs/tsconfig": "~7.4.13",
     "axios": "^1.13.6",
     "typescript": "~5.9.3",
     "vitest": "~4.0.18"