@xylabs/api 2.6.14

package/dist/esm/ApiClient.d.ts

@@ -0,0 +1,9 @@
+import { ApiStage } from './ApiStage';
+declare abstract class ApiClient {
+    constructor(token?: string | null, stage?: ApiStage);
+    protected stage: string;
+    protected token?: string | null;
+    abstract endPoint(): string;
+}
+export { ApiClient };
+//# sourceMappingURL=ApiClient.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ApiClient.d.ts","sourceRoot":"","sources":["../../src/ApiClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAErC,uBAAe,SAAS;gBACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,CAAC,EAAE,QAAQ;IAK1D,SAAS,CAAC,KAAK,EAAE,MAAM,CAAA;IAEvB,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE/B,QAAQ,CAAC,QAAQ,IAAI,MAAM;CAC5B;AAED,OAAO,EAAE,SAAS,EAAE,CAAA"}

package/dist/esm/ApiClient.js

@@ -0,0 +1,11 @@
+import { ApiStage } from './ApiStage';
+class ApiClient {
+    constructor(token, stage) {
+        this.stage = stage ?? ApiStage.Prod;
+        this.token = token;
+    }
+    stage;
+    token;
+}
+export { ApiClient };
+//# sourceMappingURL=ApiClient.js.map

package/dist/esm/ApiClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiClient.js","sourceRoot":"","sources":["../../src/ApiClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAErC,MAAe,SAAS;IACtB,YAAmB,KAAqB,EAAE,KAAgB;QACxD,IAAI,CAAC,KAAK,GAAG,KAAK,IAAI,QAAQ,CAAC,IAAI,CAAA;QACnC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;IAES,KAAK,CAAQ;IAEb,KAAK,CAAgB;CAGhC;AAED,OAAO,EAAE,SAAS,EAAE,CAAA"}

package/dist/esm/ApiConfig.d.ts

@@ -0,0 +1,8 @@
+interface ApiConfig {
+    apiDomain: string;
+    userid?: string;
+    jwtToken?: string;
+    apiKey?: string;
+}
+export type { ApiConfig };
+//# sourceMappingURL=ApiConfig.d.ts.map

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

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

package/dist/esm/ApiConfig.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ApiConfig.js.map

package/dist/esm/ApiConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiConfig.js","sourceRoot":"","sources":["../../src/ApiConfig.ts"],"names":[],"mappings":""}

package/dist/esm/ApiEndpoint.d.ts

@@ -0,0 +1,15 @@
+import { ApiConfig } from './ApiConfig';
+declare class ApiEndpoint<T> {
+    private config;
+    private path;
+    constructor(config: ApiConfig, path: string);
+    private get headers();
+    private get url();
+    private _value?;
+    get value(): T | undefined;
+    get(): Promise<T | NonNullable<T>>;
+    fetch(): Promise<T>;
+    insert(value: T): Promise<T>;
+}
+export { ApiEndpoint };
+//# sourceMappingURL=ApiEndpoint.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ApiEndpoint.d.ts","sourceRoot":"","sources":["../../src/ApiEndpoint.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC,cAAM,WAAW,CAAC,CAAC;IACjB,OAAO,CAAC,MAAM,CAAW;IACzB,OAAO,CAAC,IAAI,CAAQ;gBAER,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM;IAK3C,OAAO,KAAK,OAAO,GAElB;IAED,OAAO,KAAK,GAAG,GAEd;IAED,OAAO,CAAC,MAAM,CAAC,CAAG;IAElB,IAAW,KAAK,kBAEf;IAEY,GAAG;IAIH,KAAK;IAUL,MAAM,CAAC,KAAK,EAAE,CAAC;CAS7B;AAED,OAAO,EAAE,WAAW,EAAE,CAAA"}

package/dist/esm/ApiEndpoint.js

@@ -0,0 +1,44 @@
+import axios from 'axios';
+class ApiEndpoint {
+    config;
+    path;
+    constructor(config, path) {
+        this.config = config;
+        this.path = path;
+    }
+    get headers() {
+        return this.config.jwtToken ? { Authorization: this.config.jwtToken } : undefined;
+    }
+    get url() {
+        return `${this.config.apiDomain}/${this.path}`;
+    }
+    _value;
+    get value() {
+        return this._value;
+    }
+    async get() {
+        return this._value ?? (await this.fetch());
+    }
+    async fetch() {
+        const response = await axios.get(this.url, { headers: this.headers });
+        if (response.status === 200) {
+            this._value = response.data;
+        }
+        else {
+            throw Error('Unexpected Status Code');
+        }
+        return this._value;
+    }
+    async insert(value) {
+        const response = await axios.post(this.url, value, { headers: this.headers });
+        if (response.status === 200) {
+            this._value = response.data;
+        }
+        else {
+            throw Error('Unexpected Status Code');
+        }
+        return this._value;
+    }
+}
+export { ApiEndpoint };
+//# sourceMappingURL=ApiEndpoint.js.map

package/dist/esm/ApiEndpoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiEndpoint.js","sourceRoot":"","sources":["../../src/ApiEndpoint.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAIzB,MAAM,WAAW;IACP,MAAM,CAAW;IACjB,IAAI,CAAQ;IAEpB,YAAY,MAAiB,EAAE,IAAY;QACzC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;IAED,IAAY,OAAO;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;IACnF,CAAC;IAED,IAAY,GAAG;QACb,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,EAAE,CAAA;IAChD,CAAC;IAEO,MAAM,CAAI;IAElB,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAEM,KAAK,CAAC,GAAG;QACd,OAAO,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,CAAA;IAC5C,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAI,IAAI,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;QACxE,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;YAC3B,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAA;SAC5B;aAAM;YACL,MAAM,KAAK,CAAC,wBAAwB,CAAC,CAAA;SACtC;QACD,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,KAAQ;QAC1B,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAI,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;QAChF,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;YAC3B,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAA;SAC5B;aAAM;YACL,MAAM,KAAK,CAAC,wBAAwB,CAAC,CAAA;SACtC;QACD,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;CACF;AAED,OAAO,EAAE,WAAW,EAAE,CAAA"}

package/dist/esm/ApiStage.d.ts

@@ -0,0 +1,7 @@
+declare enum ApiStage {
+    Beta = "beta",
+    Local = "local",
+    Prod = "prod"
+}
+export { ApiStage };
+//# sourceMappingURL=ApiStage.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ApiStage.d.ts","sourceRoot":"","sources":["../../src/ApiStage.ts"],"names":[],"mappings":"AAAA,aAAK,QAAQ;IACX,IAAI,SAAS;IACb,KAAK,UAAU;IACf,IAAI,SAAS;CACd;AAED,OAAO,EAAE,QAAQ,EAAE,CAAA"}

package/dist/esm/ApiStage.js

@@ -0,0 +1,8 @@
+var ApiStage;
+(function (ApiStage) {
+    ApiStage["Beta"] = "beta";
+    ApiStage["Local"] = "local";
+    ApiStage["Prod"] = "prod";
+})(ApiStage || (ApiStage = {}));
+export { ApiStage };
+//# sourceMappingURL=ApiStage.js.map

package/dist/esm/ApiStage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiStage.js","sourceRoot":"","sources":["../../src/ApiStage.ts"],"names":[],"mappings":"AAAA,IAAK,QAIJ;AAJD,WAAK,QAAQ;IACX,yBAAa,CAAA;IACb,2BAAe,CAAA;IACf,yBAAa,CAAA;AACf,CAAC,EAJI,QAAQ,KAAR,QAAQ,QAIZ;AAED,OAAO,EAAE,QAAQ,EAAE,CAAA"}

package/dist/esm/getApiStage.d.ts

@@ -0,0 +1,4 @@
+import { ApiStage } from './ApiStage';
+declare const getApiStage: (hostname: string) => ApiStage;
+export { getApiStage };
+//# sourceMappingURL=getApiStage.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getApiStage.d.ts","sourceRoot":"","sources":["../../src/getApiStage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAErC,QAAA,MAAM,WAAW,aAAc,MAAM,aAQpC,CAAA;AAED,OAAO,EAAE,WAAW,EAAE,CAAA"}

package/dist/esm/getApiStage.js

@@ -0,0 +1,14 @@
+import { ApiStage } from './ApiStage';
+const getApiStage = (hostname) => {
+    if (hostname.startsWith('localhost')) {
+        return ApiStage.Local;
+    }
+    else if (hostname.startsWith('beta.')) {
+        return ApiStage.Beta;
+    }
+    else {
+        return ApiStage.Prod;
+    }
+};
+export { getApiStage };
+//# sourceMappingURL=getApiStage.js.map

package/dist/esm/getApiStage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getApiStage.js","sourceRoot":"","sources":["../../src/getApiStage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAErC,MAAM,WAAW,GAAG,CAAC,QAAgB,EAAE,EAAE;IACvC,IAAI,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE;QACpC,OAAO,QAAQ,CAAC,KAAK,CAAA;KACtB;SAAM,IAAI,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;QACvC,OAAO,QAAQ,CAAC,IAAI,CAAA;KACrB;SAAM;QACL,OAAO,QAAQ,CAAC,IAAI,CAAA;KACrB;AACH,CAAC,CAAA;AAED,OAAO,EAAE,WAAW,EAAE,CAAA"}

package/dist/esm/index.d.ts

@@ -0,0 +1,6 @@
+export * from './ApiClient';
+export * from './ApiConfig';
+export * from './ApiEndpoint';
+export * from './ApiStage';
+export * from './getApiStage';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA;AAC7B,cAAc,YAAY,CAAA;AAC1B,cAAc,eAAe,CAAA"}

package/dist/esm/index.js

@@ -0,0 +1,6 @@
+export * from './ApiClient';
+export * from './ApiConfig';
+export * from './ApiEndpoint';
+export * from './ApiStage';
+export * from './getApiStage';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA;AAC7B,cAAc,YAAY,CAAA;AAC1B,cAAc,eAAe,CAAA"}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "license": "LGPL-3.0",
+  "name": "@xylabs/api",
+  "author": {
+    "email": "support@xylabs.com",
+    "name": "XY Labs Development Team",
+    "url": "https://xylabs.com"
+  },
+  "bugs": {
+    "email": "support@xylabs.com",
+    "url": "https://github.com/xylabs/sdk-js/issues"
+  },
+  "workspaces": [
+    "packages/**/*"
+  ],
+  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
+  "browser": "dist/esm/index.js",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "docs": "dist/docs.json",
+  "types": "dist/esm/index.d.ts",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "browser": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "default": "./dist/esm/index.js"
+    },
+    "./dist/docs.json": {
+      "default": "./dist/docs.json"
+    },
+    "./package.json": "./package.json"
+  },
+  "homepage": "https://xylabs.com",
+  "keywords": [
+    "xylabs",
+    "utility",
+    "typescript",
+    "esm"
+  ],
+  "dependencies": {
+    "axios": "^1"
+  },
+  "devDependencies": {
+    "@xylabs/eslint-config": "2.11.16",
+    "@xylabs/ts-scripts-yarn3": "^2.11.16",
+    "eslint": "^8.30.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/xylabs/sdk-js.git"
+  },
+  "sideEffects": false,
+  "version": "2.6.14",
+  "packageManager": "yarn@3.3.1"
+}

package/src/ApiClient.ts

@@ -0,0 +1,16 @@
+import { ApiStage } from './ApiStage'
+
+abstract class ApiClient {
+  public constructor(token?: string | null, stage?: ApiStage) {
+    this.stage = stage ?? ApiStage.Prod
+    this.token = token
+  }
+
+  protected stage: string
+
+  protected token?: string | null
+
+  abstract endPoint(): string
+}
+
+export { ApiClient }

package/src/ApiConfig.ts

@@ -0,0 +1,8 @@
+interface ApiConfig {
+  apiDomain: string
+  userid?: string
+  jwtToken?: string
+  apiKey?: string
+}
+
+export type { ApiConfig }

package/src/ApiEndpoint.spec.ts

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

package/src/ApiEndpoint.ts

@@ -0,0 +1,53 @@
+import axios from 'axios'
+
+import { ApiConfig } from './ApiConfig'
+
+class ApiEndpoint<T> {
+  private config: ApiConfig
+  private path: string
+
+  constructor(config: ApiConfig, path: string) {
+    this.config = config
+    this.path = path
+  }
+
+  private get headers() {
+    return this.config.jwtToken ? { Authorization: this.config.jwtToken } : undefined
+  }
+
+  private get url() {
+    return `${this.config.apiDomain}/${this.path}`
+  }
+
+  private _value?: T
+
+  public get value() {
+    return this._value
+  }
+
+  public async get() {
+    return this._value ?? (await this.fetch())
+  }
+
+  public async fetch() {
+    const response = await axios.get<T>(this.url, { headers: this.headers })
+    if (response.status === 200) {
+      this._value = response.data
+    } else {
+      throw Error('Unexpected Status Code')
+    }
+    return this._value
+  }
+
+  public async insert(value: T) {
+    const response = await axios.post<T>(this.url, value, { headers: this.headers })
+    if (response.status === 200) {
+      this._value = response.data
+    } else {
+      throw Error('Unexpected Status Code')
+    }
+    return this._value
+  }
+}
+
+export { ApiEndpoint }

package/src/ApiStage.ts

@@ -0,0 +1,7 @@
+enum ApiStage {
+  Beta = 'beta',
+  Local = 'local',
+  Prod = 'prod',
+}
+
+export { ApiStage }

package/src/getApiStage.spec.ts

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

package/src/getApiStage.ts

@@ -0,0 +1,13 @@
+import { ApiStage } from './ApiStage'
+
+const getApiStage = (hostname: string) => {
+  if (hostname.startsWith('localhost')) {
+    return ApiStage.Local
+  } else if (hostname.startsWith('beta.')) {
+    return ApiStage.Beta
+  } else {
+    return ApiStage.Prod
+  }
+}
+
+export { getApiStage }

package/src/index.ts

@@ -0,0 +1,5 @@
+export * from './ApiClient'
+export * from './ApiConfig'
+export * from './ApiEndpoint'
+export * from './ApiStage'
+export * from './getApiStage'