newt-client-js 1.0.2 → 1.1.0

package/README.md

@@ -25,7 +25,7 @@ const { createClient } = require('newt-client-js');
 const client = createClient({
   projectUid: 'YOUR_PROJECT_UID',
   token: 'YOUR_CDN_API_TOKEN',
-  apiType: 'cdn' // You can specify "cdn" or "content".
+  apiType: 'cdn' // You can specify "cdn" or "api".
 });
 
 client
@@ -38,19 +38,6 @@ client
   .catch((err) => console.log(err));
 ```
 
-### Using this library with the Content API
-
-This library can also be used with the Content API. In order to do so, you need to use the Content API token, available on the same page where you get the CDN API token, such as:
-
-```js
-const { createClient } = require('newt-client-js');
-const client = createClient({
-  projectUid: 'YOUR_PROJECT_UID',
-  token: 'YOUR_CONTENT_API_TOKEN',
-  apiType: 'content'
-});
-```
-
 ## Documentation & References
 
 Please refer to the [REST API reference](https://developers.newt.so/) for the parameters and operators that can be used for query.
@@ -64,8 +51,8 @@ The `createClient` method supports several options you may set to achieve the ex
 | Name | Default | Description |
 | :--- | :--- | :--- |
 | `projectUid` | | **Required.** Your project uid. |
-| `token` | | **Required.** Your CDN API token or Content API token. |
-| `apiType` | `cdn` | You can specify "cdn" or "content". |
+| `token` | | **Required.** Your Newt CDN API token or Newt API token. |
+| `apiType` | `cdn` | You can specify `cdn` or `api`. Please specify `cdn` to send a request to the Newt CDN API, or `api` to send a request to the Newt API. |
 
 ### Get contents
 
@@ -122,16 +109,30 @@ client
   .catch((err) => console.log(err));
 ```
 
+### Get an app
+
+```js
+client
+  .getApp({
+    appUid: 'YOUR_APP_UID'
+  })
+  .then((app) => console.log(app))
+  .catch((err) => console.log(err));
+```
+
 ### Usage with TypeScript
 
-The type of the content you want to get can be passed as a parameter.
+#### Type definition
+
+By using the type Content, you can easily define the type.
 
 ```ts
 // Suppose you have defined a model named Post in the admin page.
 
 // Type definition
 /**
- * // Content type
+ * Content type
+ *
  * {
  *   _id: string;
  *   _sys: {
@@ -153,10 +154,16 @@ interface Post extends Content {
   title: string
   body: string
 }
+```
+
+#### Request and Response
 
-// Request
+The type of the content you want to get can be passed as a parameter.
+
+```ts
 /**
- * // getContents response type
+ * getContents response type
+ *
  * {
  *   skip: number;
  *   limit: number;
@@ -172,7 +179,8 @@ client.getContents<Post>({
   .catch((err) => console.log(err));
 
 /**
- * // getContent response type
+ * getContent response type
+ *
  * {
  *   _id: string;
  *   _sys: {
@@ -201,6 +209,37 @@ client
   .catch((err) => console.log(err));
 ```
 
+#### Query Fields
+
+All fields are optional.
+
+| Field | Type | Description |
+| :--- | :--- | :--- |
+| `YOUR_FIELD` | - | You can define a query for a field that you define |
+| `select` | string[] | |
+| `order` | string[] | |
+| `limit` | number | |
+| `skip` | number| |
+| `depth` | number | |
+| `or` | Array | Connects each element in the array as an "or" condition. |
+| `and` | Array | Connects each element in the array as an "and" condition. |
+
+#### Query Operators
+
+| Operator | Type |
+| :--- | :--- |
+| `ne` | string / number / boolean |
+| `match` | string |
+| `in` | string[] / number[] |
+| `nin` | string[] / number[] |
+| `all` | string[] / number[] |
+| `exists` | boolean |
+| `lt` | string / number |
+| `lte` | string / number |
+| `gt` | string / number |
+| `gte` | string / number |
+| `fmt` | 'text' |
+
 ## License
 
 This repository is published under the [MIT License](https://github.com/Newt-Inc/newt-client-js/blob/main/LICENSE).

package/dist/createClient.d.ts

@@ -1,5 +1,6 @@
-import { CreateClientParams, GetContentsParams, GetContentParams, Contents } from './types';
+import { CreateClientParams, GetContentsParams, GetContentParams, Contents, GetAppParams, AppMeta } from './types';
 export declare const createClient: ({ projectUid, token, apiType, }: CreateClientParams) => {
     getContents: <T>({ appUid, modelUid, query, }: GetContentsParams) => Promise<Contents<T>>;
     getContent: <T_1>({ appUid, modelUid, contentId, query, }: GetContentParams) => Promise<T_1>;
+    getApp: ({ appUid }: GetAppParams) => Promise<AppMeta | null>;
 };

package/dist/createClient.js

@@ -41,37 +41,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createClient = void 0;
 var axios_1 = __importDefault(require("axios"));
-var qs_1 = __importDefault(require("qs"));
-var parseOrQuery = function (orQuery) {
-    var orConditions = [];
-    orQuery.forEach(function (query) {
-        if (query.or) {
-            orConditions.push(parseOrQuery(query.or));
-        }
-        else {
-            orConditions.push(qs_1.default.stringify(query, { encode: false, arrayFormat: 'comma' }));
-        }
-    });
-    var q = '[or]=(' + orConditions.join(';') + ')';
-    return q;
-};
-var parseQuery = function (query) {
-    if (!query.or)
-        return qs_1.default.stringify(query, { encode: false, arrayFormat: 'comma' });
-    var orQuery = parseOrQuery(query.or);
-    delete query.or;
-    var q = qs_1.default.stringify(query, { encode: false, arrayFormat: 'comma' });
-    q = q ? q + '&' + orQuery : orQuery;
-    return q;
-};
+var parseQuery_1 = require("./utils/parseQuery");
 var createClient = function (_a) {
     var projectUid = _a.projectUid, token = _a.token, _b = _a.apiType, apiType = _b === void 0 ? 'cdn' : _b;
     if (!projectUid)
         throw new Error('projectUid parameter is required.');
     if (!token)
         throw new Error('token parameter is required.');
-    if (!['cdn', 'content'].includes(apiType))
-        throw new Error("apiType parameter should be set to \"cdn\" or \"content\". apiType: " + apiType);
+    if (!['cdn', 'api'].includes(apiType))
+        throw new Error("apiType parameter should be set to \"cdn\" or \"api\". apiType: " + apiType);
     var axiosInstance = axios_1.default.create({
         baseURL: "https://" + projectUid + "." + apiType + ".newt.so/v1",
         headers: { Authorization: "Bearer " + token },
@@ -89,7 +67,7 @@ var createClient = function (_a) {
                             throw new Error('model parameter is required.');
                         url = "/" + appUid + "/" + modelUid;
                         if (query && Object.keys(query).length) {
-                            url = url + '?' + parseQuery(query);
+                            url = url + '?' + (0, parseQuery_1.parseQuery)(query);
                         }
                         return [4 /*yield*/, axiosInstance.get(url)];
                     case 1:
@@ -114,7 +92,7 @@ var createClient = function (_a) {
                             throw new Error('contentId parameter is required.');
                         url = "/" + appUid + "/" + modelUid + "/" + contentId;
                         if (query && Object.keys(query).length) {
-                            url = url + '?' + parseQuery(query);
+                            url = url + '?' + (0, parseQuery_1.parseQuery)(query);
                         }
                         return [4 /*yield*/, axiosInstance.get(url)];
                     case 1:
@@ -124,9 +102,28 @@ var createClient = function (_a) {
             });
         });
     };
+    var getApp = function (_a) {
+        var appUid = _a.appUid;
+        return __awaiter(void 0, void 0, void 0, function () {
+            var url, data;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        if (!appUid)
+                            throw new Error('appUid parameter is required.');
+                        url = "/project/apps/" + appUid;
+                        return [4 /*yield*/, axiosInstance.get(url)];
+                    case 1:
+                        data = (_b.sent()).data;
+                        return [2 /*return*/, data];
+                }
+            });
+        });
+    };
     return {
         getContents: getContents,
         getContent: getContent,
+        getApp: getApp,
     };
 };
 exports.createClient = createClient;

package/dist/index.d.ts

@@ -1,2 +1,2 @@
 export { createClient } from './createClient';
-export { CreateClientParams, GetContentsParams, GetContentParams, GetContentsQuery, GetContentQuery, Contents, Content, } from './types';
+export { CreateClientParams, GetContentsParams, GetContentParams, GetContentsQuery, GetContentQuery, Contents, Content, AppMeta, AppCover, AppIcon, GetAppParams, } from './types';

package/dist/types.d.ts

@@ -1,7 +1,7 @@
 export interface CreateClientParams {
     projectUid: string;
     token: string;
-    apiType?: 'cdn' | 'content';
+    apiType?: 'cdn' | 'api';
 }
 export interface GetContentsParams {
     appUid: string;
@@ -28,11 +28,10 @@ declare type OperatorValue = {
     fmt?: 'text';
 };
 declare type QueryValue = string | number | boolean | OperatorValue;
-declare type AtomicQuery = {
-    [key: string]: QueryValue;
-};
-export declare type OrQuery = {
-    or: Array<AtomicQuery | OrQuery>;
+export declare type FilterQuery = {
+    or?: Array<FilterQuery>;
+    and?: Array<FilterQuery>;
+    [key: string]: QueryValue | Array<FilterQuery> | undefined;
 };
 export declare type Query = {
     select?: string[];
@@ -40,8 +39,9 @@ export declare type Query = {
     limit?: number;
     skip?: number;
     depth?: number;
-    or?: Array<AtomicQuery | OrQuery>;
-    [key: string]: QueryValue | string[] | Array<AtomicQuery | OrQuery> | undefined;
+    or?: Array<FilterQuery>;
+    and?: Array<FilterQuery>;
+    [key: string]: QueryValue | string[] | Array<FilterQuery> | undefined;
 };
 export declare type GetContentsQuery = Query;
 declare type ExceptFormat = {
@@ -75,4 +75,21 @@ export interface Content {
         };
     };
 }
+export declare type AppIcon = {
+    type: string;
+    value: string;
+};
+export declare type AppCover = {
+    type: string;
+    value: string;
+};
+export interface AppMeta {
+    name: string;
+    uid: string;
+    icon?: AppIcon;
+    cover?: AppCover;
+}
+export interface GetAppParams {
+    appUid: string;
+}
 export {};

package/dist/utils/parseQuery.d.ts

@@ -0,0 +1,2 @@
+import { Query } from '../types';
+export declare const parseQuery: (query: Query) => string;

package/dist/utils/parseQuery.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseQuery = void 0;
+var qs_1 = __importDefault(require("qs"));
+var parseAndQuery = function (andQuery) {
+    if (!andQuery)
+        throw new Error('invalid query');
+    var andConditions = [];
+    andQuery.forEach(function (query) {
+        andConditions.push((0, exports.parseQuery)(query));
+    });
+    var q = andConditions.join('&');
+    return q;
+};
+var parseOrQuery = function (orQuery) {
+    if (!orQuery)
+        throw new Error('invalid query');
+    var orConditions = [];
+    orQuery.forEach(function (query) {
+        orConditions.push((0, exports.parseQuery)(query));
+    });
+    var q = '[or]=(' + orConditions.join(';') + ')';
+    return q;
+};
+var parseQuery = function (query) {
+    var andQuery = '';
+    if (query.and) {
+        andQuery = parseAndQuery(query.and);
+        delete query.and;
+    }
+    var orQuery = '';
+    if (query.or) {
+        orQuery = parseOrQuery(query.or);
+        delete query.or;
+    }
+    var q = qs_1.default.stringify(query, { encode: false, arrayFormat: 'comma' });
+    q = [q, orQuery, andQuery].filter(function (queryString) { return queryString; }).join('&');
+    return q;
+};
+exports.parseQuery = parseQuery;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newt-client-js",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "JavaScript SDK for Newt's API",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -19,20 +19,40 @@
     "lint:prettier": "prettier --check ./src",
     "fix:eslint": "prettier --fix ./src",
     "fix:prettier": "prettier --write ./src",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "jest"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "ts",
+      "js"
+    ],
+    "transform": {
+      "^.+\\.ts$": "ts-jest"
+    },
+    "globals": {
+      "ts-jest": {
+        "tsconfig": "tests/tsconfig.json"
+      }
+    },
+    "testMatch": [
+      "**/tests/**/*.test.ts"
+    ]
   },
   "dependencies": {
     "axios": "^0.21.1",
     "qs": "^6.10.1"
   },
   "devDependencies": {
+    "@types/jest": "^27.0.3",
     "@types/node": "^16.7.8",
     "@types/qs": "^6.9.7",
     "@typescript-eslint/eslint-plugin": "^4.30.0",
     "@typescript-eslint/parser": "^4.30.0",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.3.0",
+    "jest": "^27.4.3",
     "prettier": "^2.3.2",
+    "ts-jest": "^27.1.0",
     "typescript": "^4.4.2"
   }
 }