@uidev1116/acms-js-sdk 0.0.2 → 0.0.3

package/README.md

@@ -1,3 +1,196 @@
 # acms-js-sdk
 
-a-blog cms JavaScript SDK
+JavaScript SDK for a-blog cms. Works in Node.js and modern browsers.
+
+## Installation
+
+```bash
+npm install acms-js-sdk
+
+# or
+
+yarn add acms-js-sdk
+```
+
+## Usage
+
+First, you need to create a client instance.
+
+ES Modules:
+
+```js
+import { createClient } from 'acms-js-sdk';
+
+const acmsClient = createClient({
+  baseUrl: 'YOUR_BASE_URL',
+  apiKey: 'YOUR_API_KEY',
+});
+```
+
+CommonJS:
+
+```js
+const { createClient } = require('acms-js-sdk');
+
+const acmsClient = createClient({
+  baseUrl: 'YOUR_BASE_URL',
+  apiKey: 'YOUR_API_KEY',
+});
+```
+
+CDN:
+
+```html
+<script type="module">
+  const { createClient } = 'https://unpkg.com/acms-js-sdk/dist/es/acms-js-sdk.js';
+
+  const acmsClient = createClient({
+    baseUrl: 'YOUR_BASE_URL',
+    apiKey: 'YOUR_API_KEY',
+  });
+</script>
+```
+
+Then, you can use `get` method.
+
+Specify the module ID to be used in the module's GET API function in the `api`, and information on the specified module ID can be fetched.
+
+```js
+acmsClient
+  .get({
+    api: 'MODULE_ID',
+  })
+  .then((response) => {
+    console.log(response.data);
+  })
+  .catch((error) => {
+    console.error(error);
+  });
+```
+
+Relative paths can also be specified.
+
+```js
+acmsClient
+  .get('api/MODULE_ID')
+  .then((response) => {
+    console.log(response.data);
+  })
+  .catch((error) => {
+    console.error(error);
+  });
+```
+
+### Url Context
+
+You can specify the URL context.
+
+```js
+acmsClient
+  .get({
+    blog: 'BLOG_CODE',
+    category: 'CATEGORY_CODE',
+    entry: 'ENTRY_CODE',
+    api: 'MODULE_ID',
+  })
+  .then((response) => {
+    console.log(response.data);
+  })
+  .catch((error) => {
+    console.error(error);
+  });
+```
+
+### Error Handling
+
+You can handle errors.
+
+Youb can check if the error is `AcmsFetchError` by using `isAcmsFetchError`.
+
+```js
+acmsClient
+  .get({
+    api: 'MODULE_ID',
+  })
+  .then((response) => {
+    console.log(response.data);
+  })
+  .catch((error) => {
+    if (acmsClient.isAcmsFetchError(error)) {
+      console.error(error.response.data);
+      return;
+    }
+    console.error(error);
+  });
+```
+
+## acmsPath
+
+You can get the path of Url Context by using utility function `acmsPath`.
+
+```js
+
+import { acmsPath } from 'acms-js-sdk';
+
+const path = acmsPath({
+  blog: 'BLOG_CODE',
+  category: 'CATEGORY_CODE',
+  entry: 'ENTRY_CODE',
+  // user: 1,
+  // tag: ['tag1', 'tag2'],
+  // field: 'color/eq/red',
+  // span: { start: '2021-01-01', end: '2021-12-31' },
+  // date: { year: 2021, month: 1, day: 1 },
+  // page: 1,
+  // order: 'id-asc',
+  // limit: 10,
+  // keyword: 'KEYWORD',
+  // tpl: 'include/sample.json'
+  api: 'MODULE_ID',
+});
+```
+
+### Params Type
+
+```ts
+interface AcmsContext {
+  blog?: string | number;
+  category?: string | string[] | number;
+  entry?: string | number;
+  user?: number;
+  tag?: string[];
+  field?: string;
+  span?: { start?: string | Date; end?: string | Date };
+  date?: { year?: number; month?: number; day?: number };
+  page?: number;
+  order?: string;
+  limit?: number;
+  keyword?: string;
+  tpl?: string;
+  api?: string;
+  searchParams?: ConstructorParameters<typeof URLSearchParams>[0];
+}
+```
+
+## isAcmsFetchError
+
+You can check if the error is `AcmsFetchError` by using utility function `isAcmsFetchError`.
+
+```js
+import { isAcmsFetchError } from 'acms-js-sdk';
+
+acmsClient
+  .get({
+    api: 'MODULE_ID',
+  })
+  .then((response) => {
+    console.log(response.data);
+  })
+  .catch((error) => {
+    if (isAcmsFetchError(error)) {
+      console.error(error.response.data);
+      return;
+    }
+    console.error(error);
+  });
+```

package/dist/cjs/acms-js-sdk.cjs

@@ -1,4 +1,4 @@
-"use strict";var P=Object.defineProperty;var q=(t,e,r)=>e in t?P(t,e,{enumerable:!0,configurable:!0,writable:!0,value:r}):t[e]=r;var n=(t,e,r)=>(q(t,typeof e!="symbol"?e+"":e,r),r);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const w=require("./acms-path.cjs"),o=require("../typeGuard-eqTQ9U-x.cjs"),c=require("../index-x-5Zn68j.cjs");async function b(t){try{const{message:e}=await t.json();return e??null}catch{return null}}async function A(){if(typeof fetch>"u"){const{default:t}=await Promise.resolve().then(()=>require("../browser-ponyfill-fsIF2jNb.cjs")).then(e=>e.browserPonyfill);return t}return fetch}async function F(...t){if(typeof Headers>"u"){const{Headers:e}=await Promise.resolve().then(()=>require("../browser-ponyfill-fsIF2jNb.cjs")).then(r=>r.browserPonyfill);return new e(...t)}return new Headers(...t)}const U={responseType:"json"};class ${constructor({baseUrl:e,apiKey:r,...i}){n(this,"baseUrl");n(this,"apiKey");n(this,"config");if(e==null&&e==="")throw new Error("baseUrl is required.");if(r==null&&r==="")throw new Error("apiKey is required.");if(!o.isString(e))throw new Error("baseUrl must be string.");if(!o.isString(r))throw new Error("apiKey must be string.");this.baseUrl=e,this.apiKey=r,this.config={...U,...i}}async request(e,r={}){const i={...this.config,...r},{requestInit:l,responseType:d}=i,y=await A(),m=this.createUrl(e),p=await this.createFetchOptions(l);try{const s=await y(m,p),{ok:E,status:a,statusText:u,headers:g}=s,h={data:await s[d](),status:a,statusText:u,headers:g};if(!E){const f=await b(s);return await Promise.reject(new c.AcmsFetchError(`fetch API response status: ${a}${f!=null?`
+"use strict";var P=Object.defineProperty;var q=(t,e,r)=>e in t?P(t,e,{enumerable:!0,configurable:!0,writable:!0,value:r}):t[e]=r;var n=(t,e,r)=>(q(t,typeof e!="symbol"?e+"":e,r),r);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const w=require("./acms-path.cjs"),o=require("../typeGuard-eqTQ9U-x.cjs"),c=require("../index-x-5Zn68j.cjs");async function b(t){try{const{message:e}=await t.json();return e??null}catch{return null}}async function A(){if(typeof fetch>"u"){const{default:t}=await Promise.resolve().then(()=>require("../browser-ponyfill-fsIF2jNb.cjs")).then(e=>e.browserPonyfill);return t}return fetch}async function F(...t){if(typeof Headers>"u"){const{Headers:e}=await Promise.resolve().then(()=>require("../browser-ponyfill-fsIF2jNb.cjs")).then(r=>r.browserPonyfill);return new e(...t)}return new Headers(...t)}const U={responseType:"json"};class ${constructor({baseUrl:e,apiKey:r,...i}){n(this,"baseUrl");n(this,"apiKey");n(this,"config");if(e!=null&&e==="")throw new Error("baseUrl is required.");if(r!=null&&r==="")throw new Error("apiKey is required.");if(!o.isString(e))throw new Error("baseUrl must be string.");if(!o.isString(r))throw new Error("apiKey must be string.");this.baseUrl=e,this.apiKey=r,this.config={...U,...i}}async request(e,r={}){const i={...this.config,...r},{requestInit:l,responseType:d}=i,y=await A(),m=this.createUrl(e),p=await this.createFetchOptions(l);try{const s=await y(m,p),{ok:E,status:a,statusText:u,headers:g}=s,h={data:await s[d](),status:a,statusText:u,headers:g};if(!E){const f=await b(s);return await Promise.reject(new c.AcmsFetchError(`fetch API response status: ${a}${f!=null?`
   message is \`${f}\``:""}`,`${a} ${u}`,h))}return h}catch(s){return s instanceof Error?await Promise.reject(new Error(`Network Error.
   Details: ${s.message}`)):await Promise.reject(new Error(`Network Error.
   Details: Unknown Error`))}}async createFetchOptions(e){const r=await F(e==null?void 0:e.headers);return r.has("X-API-KEY")||r.set("X-API-KEY",this.apiKey),{...e,headers:r}}createUrl(e){return o.isString(e)?new URL(e,this.baseUrl):e instanceof URL?new URL(e,this.baseUrl):new URL(w({...e}),this.baseUrl)}async get(e,r={}){return await this.request(e,{...r,requestInit:{...r.requestInit,method:"GET"}})}static isAcmsFetchError(e){return c.isAcmsFetchError(e)}}function j(...t){return new $(...t)}exports.acmsPath=w;exports.isAcmsFetchError=c.isAcmsFetchError;exports.createClient=j;

package/dist/es/acms-js-sdk.js

@@ -38,9 +38,9 @@ class R {
     n(this, "baseUrl");
     n(this, "apiKey");
     n(this, "config");
-    if (e == null && e === "")
+    if (e != null && e === "")
       throw new Error("baseUrl is required.");
-    if (r == null && r === "")
+    if (r != null && r === "")
       throw new Error("apiKey is required.");
     if (!i(e))
       throw new Error("baseUrl must be string.");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uidev1116/acms-js-sdk",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "a-blog cms JavaScript SDK",
   "type": "module",
   "files": [