[add] Filter Operator types & option of Strapi REST API

Author: TechQuery

wrapper/Strapi/ReadMe.md

@@ -53,15 +53,23 @@ if (!['localhost', '127.0.0.1', '0.0.0.0'].includes(location.hostname))
 ### `model/Article.ts`
 
 ```typescript
-import { StrapiListModel } from 'mobx-strapi';
+import { Base, BaseUser, StrapiListModel } from 'mobx-strapi';
 
 import { session } from './Session';
 
-export type Article = Record<'id' | 'title' | 'summary', string>;
+export interface Article extends Base, Record<'title' | 'summary', string> {
+    author: BaseUser;
+}
 
 export class ArticleModel extends StrapiListModel<Article> {
     client = session.client;
     baseURI = 'articles';
+    // for Strapi 5
+    indexKey = 'documentId';
+    // optional
+    operator = { title: '$containsi' } as const;
+    // optional
+    searchKeys = ['title', 'summary'] as const;
 }
 
 export default new ArticleModel();
@@ -75,12 +83,13 @@ Use [WebCell][7] as an Example
 import { component, observer } from 'web-cell';
 
 import articleStore from '../../model/Article';
+import { sessionStore } from '../../model/Session';
 
 @component({ tagName: 'article-page' })
 @observer
 export class ArticlePage extends HTMLElement {
     connectedCallback() {
-        articleStore.getList();
+        articleStore.getList({ author: sessionStore.user?.documentId });
     }
 
     disconnectedCallback() {

wrapper/Strapi/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mobx-strapi",
-    "version": "0.6.6",
+    "version": "0.6.7",
     "license": "LGPL-3.0",
     "author": "[email protected]",
     "description": "MobX SDK for Strapi headless CMS",

wrapper/Strapi/source/index.ts

@@ -1,4 +1,4 @@
-import { TypeKeys } from 'web-utility';
+import { IndexKey, TypeKeys } from 'web-utility';
 import { stringify } from 'qs';
 import { computed, observable } from 'mobx';
 import {
@@ -9,6 +9,7 @@ import {
     ListModel,
     toggle
 } from 'mobx-restful';
+import { Base } from './Session';
 
 export * from './Session';
 
@@ -45,6 +46,31 @@ export type StrapiNestedData<T extends DataObject> = {
           : T[K];
 };
 
+export type NotableOperator<T extends string> =
+    | `$${T}`
+    | `$not${Capitalize<T>}`;
+
+export type CaseInsensitive<T extends `$${string}`> = T | `${T}i`;
+
+export type StrapiFilterOperator =
+    | CaseInsensitive<'$eq'>
+    | CaseInsensitive<'$ne'>
+    | `$${'l' | 'g'}t${'' | 'e'}`
+    | NotableOperator<'in'>
+    | CaseInsensitive<NotableOperator<'contains'>>
+    | NotableOperator<'null'>
+    | '$between'
+    | CaseInsensitive<`$${'start' | 'end'}sWith`>
+    | '$or'
+    | '$and'
+    | '$not';
+export type StrapiFilterValue<T = any> = Record<StrapiFilterOperator, T>;
+
+export type StrapiFilter<Index extends IndexKey> = Record<
+    string,
+    StrapiFilterValue | Record<Index, StrapiFilterValue>
+>;
+
 export type StrapiPopulateQuery<D extends DataObject> = {
     [K in TypeKeys<D, DataObject | DataObject[]>]?: {
         populate:
@@ -56,9 +82,14 @@ export type StrapiPopulateQuery<D extends DataObject> = {
 };
 
 export abstract class StrapiListModel<
-    D extends DataObject,
+    D extends Base,
     F extends Filter<D> = Filter<D>
 > extends ListModel<D, F> {
+    operator = {
+        createdAt: '$startsWith',
+        updatedAt: '$startsWith'
+    } as Partial<Record<keyof D, StrapiFilterOperator>>;
+
     populate: StrapiPopulateQuery<D> = {};
 
     searchKeys: readonly TypeKeys<D, string>[] = [];
@@ -118,19 +149,16 @@ export abstract class StrapiListModel<
     }
 
     makeFilter(pageIndex: number, pageSize: number, filter: F) {
-        const { indexKey, populate, keywords } = this;
+        const { indexKey, operator, populate, keywords } = this;
 
         const filters = Object.fromEntries(
             Object.entries(filter).map(([key, value]) => [
                 key,
                 key in populate
                     ? { [indexKey]: { $eq: value } }
-                    : { $eq: value }
+                    : { [key in operator ? operator[key] : '$eq']: value }
             ])
-        ) as Record<
-            string,
-            { $eq: any } | { [key in typeof indexKey]: { $eq: any } }
-        >;
+        ) as StrapiFilter<typeof indexKey>;
 
         return {
             populate,