* feat: nocobase build * chore: update build scripts * chore: update build scripts * chore(versions): 😊 publish v0.7.0-alpha.33 * chore: independent version * chore: nocobase build * chore(versions): 😊 publish v0.7.0-alpha.34 * feat: nocobase-cli * feat: nocobase-cli * chore: update dependencies * feat: improve code * refactor: create-nocobase-app * chore(versions): 😊 publish v0.7.0-alpha.35 * feat: @nocobase/devtools * chore(versions): 😊 publish v0.7.0-alpha.36 * chore: update dependencies * chore(versions): 😊 publish v0.7.0-alpha.37 * feat: improve code * chore(versions): 😊 publish v0.7.0-alpha.38 * feat: improve code * chore(versions): 😊 publish v0.7.0-alpha.39 * feat: update deps * chore(versions): 😊 publish v0.7.0-alpha.40 * chore: update devDependencies * chore(versions): 😊 publish v0.7.0-alpha.41 * fix: postinstall * chore(versions): 😊 publish v0.7.0-alpha.42 * chore: improve code * chore(versions): 😊 publish v0.7.0-alpha.43 * chore: execa * chore(versions): 😊 publish v0.7.0-alpha.44 * chore(cli): allow unknown option * chore(versions): 😊 publish v0.7.0-alpha.45 * fix: default envs * chore(versions): 😊 publish v0.7.0-alpha.45 * fix: package argument for build command * chore(versions): 😊 publish v0.7.0-alpha.46 * fix: improve code * chore(versions): 😊 publish v0.7.0-alpha.48 * feat: clean & doc * chore(versions): 😊 publish v0.7.0-alpha.49 * feat: compilation tips * feat: upgrade command * chore(versions): 😊 publish v0.7.0-alpha.50 * fix: unexpected token ] in JSON * chore(versions): 😊 publish v0.7.0-alpha.51 * fix: upgrade command * chore(versions): 😊 publish v0.7.0-alpha.52 * fix: remove export action from available action * fix: db sync after upgrade * chore(versions): 😊 publish v0.7.0-alpha.53 * feat: upgrade log * chore(versions): 😊 publish v0.7.0-alpha.54 * docs: updates * feat: updates * docs(cli): update usage description * feat: updates * docs: updates * docs: updates * docs: toc * feat: sdk * docs: updates * docs: updates * docs: updates * Update index.md * docs: updates * Update release-notes.md * Update roadmap.md * Update index.md * Update contributing.md * Update contributing.md * Update index.md * Update index.md * Update nocobase-cli.md * Update nocobase-cli.md * fix: user plugin initialization data * Update env.md * Update env.md * Update directory-structure.md * Update index.md * Update action-api.md * Update filter-operators.md * docs: update thanks.md * Update index.md * Update javascript-sdk.md * Update rest-api.md * Update installation.md * Update installation.md * Update upgrading.md * Update upgrading.md * Update upgrading.md * Update installation.md * Update installation.md * Create release-notes.md * Update release-notes.md * feat: updates * feat: update docs * feat: update release-notes.md * feat: switch language * feat: updates * Add files via upload * Add files via upload * Update important-features.md * Update thanks.md * feat: nocobase postinstall * Update index.md * Create why-different.md * Update why-different.md * Create who-is-for.md * Rename who-is-for.md to who.md * feat: update docs * Rename why-different.md to why.md * Update why.md * Update menus.ts * Update why-nocobase.md * Create who.md * Create why.md * feat: updates * chore(versions): 😊 publish v0.7.0-alpha.55 * feat: tips * Update who.md * Update who.md * feat: update docs * feat: update doc menus * fix: plugin client dist * docs: update contributing.md * docs: update readme.md * docs: update readme.md * docs: update readme.md * Update functional-zoning.md * fix: br Co-authored-by: Zhou <zhou.working@gmail.com>
		
			
				
	
	
		
			230 lines
		
	
	
		
			4.2 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
			
		
		
	
	
			230 lines
		
	
	
		
			4.2 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
| # JavaScript SDK
 | |
| 
 | |
| ## APIClient
 | |
| 
 | |
| ```ts
 | |
| class APIClient {
 | |
|   // axios instance
 | |
|   axios: AxiosInstance;
 | |
|   // constructors
 | |
|   constructor(instance?: AxiosInstance | AxiosRequestConfig);
 | |
|   // Client-side requests, support for AxiosRequestConfig and ResourceActionOptions
 | |
|   request<T = any, R = AxiosResponse<T>, D = any>(config: AxiosRequestConfig<D> | ResourceActionOptions): Promise<R>;
 | |
|   // Get Resources
 | |
|   resource<R = IResource>(name: string, of?: any): R;
 | |
| }
 | |
| ```
 | |
| 
 | |
| Initialize instance
 | |
| 
 | |
| ```ts
 | |
| import axios from 'axios';
 | |
| import { APIClient } from '@nocobase/sdk';
 | |
| 
 | |
| // Provide AxiosRequestConfig configuration parameters
 | |
| const api = new APIClient({
 | |
|   baseURL: 'https://localhost:8000/api',
 | |
| });
 | |
| 
 | |
| // Provide AxiosInstance
 | |
| const instance = axios.create({
 | |
|   baseURL: 'https://localhost:8000/api',
 | |
| });
 | |
| const api = new APIClient(instance);
 | |
| ```
 | |
| 
 | |
| ## Mock
 | |
| 
 | |
| ```ts
 | |
| import { APIClient } from '@nocobase/sdk';
 | |
| import MockAdapter from 'axios-mock-adapter';
 | |
| 
 | |
| const api = new APIClient({
 | |
|   baseURL: 'https://localhost:8000/api',
 | |
| });
 | |
| 
 | |
| const mock = new MockAdapter(api.axios);
 | |
| 
 | |
| mock.onGet('users:get').reply(200, {
 | |
|   data: { id: 1, name: 'John Smith' },
 | |
| });
 | |
| 
 | |
| await api.request({ url: 'users:get' });
 | |
| ```
 | |
| 
 | |
| ## Auth
 | |
| 
 | |
| ```ts
 | |
| // Pass token directly
 | |
| api.auth.token = '123';
 | |
| // Or sign in via signIn
 | |
| api.auth.signIn();
 | |
| // Log out and delete the token cache
 | |
| api.auth.signOut();
 | |
| ```
 | |
| 
 | |
| ## Request
 | |
| 
 | |
| ```ts
 | |
| // url
 | |
| await api.request({
 | |
|   url: 'users:list',
 | |
|   // request params
 | |
|   params: {
 | |
|     filter: {
 | |
|       'email.$includes': 'noco',
 | |
|     },
 | |
|   },
 | |
|   // request body
 | |
|   data,
 | |
| });
 | |
| 
 | |
| // resource & action
 | |
| await api.request({
 | |
|   resource: 'users',
 | |
|   action: 'list',
 | |
|   // action params
 | |
|   params: {
 | |
|     filter: {
 | |
|       'email.$includes': 'noco',
 | |
|     },
 | |
|     page: 1,
 | |
|   },
 | |
| });
 | |
| ```
 | |
| 
 | |
| ## Resource action
 | |
| 
 | |
| ```ts
 | |
| await api.resource('collection')[action]();
 | |
| await api.resource('collection.association', collectionId)[action]();
 | |
| ```
 | |
| 
 | |
| ## Action API
 | |
| 
 | |
| ```ts
 | |
| await api.resource('collection').create();
 | |
| await api.resource('collection').get();
 | |
| await api.resource('collection').list();
 | |
| await api.resource('collection').update();
 | |
| await api.resource('collection').destroy();
 | |
| await api.resource('collection.association', collectionId).create();
 | |
| await api.resource('collection.association', collectionId).get();
 | |
| await api.resource('collection.association', collectionId).list();
 | |
| await api.resource('collection.association', collectionId).update();
 | |
| await api.resource('collection.association', collectionId).destroy();
 | |
| ```
 | |
| 
 | |
| ### `get`
 | |
| 
 | |
| ```ts
 | |
| interface Resource {
 | |
|   get: (options?: GetActionOptions) => Promise<any>;
 | |
| }
 | |
| 
 | |
| interface GetActionOptions {
 | |
|   filter?: any;
 | |
|   filterByTk?: any;
 | |
|   fields?: string || string[];
 | |
|   appends?: string || string[];
 | |
|   expect?: string || string[];
 | |
|   sort?: string[];
 | |
| }
 | |
| ```
 | |
| 
 | |
| ### `list`
 | |
| 
 | |
| ```ts
 | |
| interface Resource {
 | |
|   list: (options?: ListActionOptions) => Promise<any>;
 | |
| }
 | |
| 
 | |
| interface ListActionOptions {
 | |
|   filter?: any;
 | |
|   filterByTk?: any;
 | |
|   fields?: string || string[];
 | |
|   appends?: string || string[];
 | |
|   expect?: string || string[];
 | |
|   sort?: string[];
 | |
|   page?: number;
 | |
|   pageSize?: number;
 | |
|   paginate?: boolean;
 | |
| }
 | |
| ```
 | |
| 
 | |
| ### `create`
 | |
| 
 | |
| ```ts
 | |
| interface Resource {
 | |
|   create: (options?: CreateActionOptions) => Promise<any>;
 | |
| }
 | |
| 
 | |
| interface CreateActionOptions {
 | |
|   whitelist?: string[];
 | |
|   blacklist?: string[];
 | |
|   values?: {[key: sting]: any};
 | |
| }
 | |
| ```
 | |
| 
 | |
| ### `update`
 | |
| 
 | |
| ```ts
 | |
| interface Resource {
 | |
|   update: (options?: UpdateActionOptions) => Promise<any>;
 | |
| }
 | |
| 
 | |
| interface UpdateActionOptions {
 | |
|   filter?: any;
 | |
|   filterByTk?: any;
 | |
|   whitelist?: string[];
 | |
|   blacklist?: string[];
 | |
|   values?: {[key: sting]: any};
 | |
| }
 | |
| ```
 | |
| 
 | |
| ### `destroy`
 | |
| 
 | |
| ```ts
 | |
| interface Resource {
 | |
|   destroy: (options?: DestroyActionOptions) => Promise<any>;
 | |
| }
 | |
| 
 | |
| interface DestroyActionOptions {
 | |
|   filter?: any;
 | |
|   filterByTk?: any;
 | |
| }
 | |
| ```
 | |
| 
 | |
| ### `move`
 | |
| 
 | |
| ```ts
 | |
| interface Resource {
 | |
|   move: (options?: MoveActionOptions) => Promise<any>;
 | |
| }
 | |
| 
 | |
| interface MoveActionOptions {
 | |
|   sourceId: any;
 | |
|   targetId?: any;
 | |
|   /** @default 'sort' */
 | |
|   sortField?: any;
 | |
|   targetScope?: {[key: string]: any};
 | |
|   sticky?: boolean;
 | |
|   method?: 'insertAfter' | 'prepend';
 | |
| }
 | |
| ```
 | |
| 
 | |
| ### `<custom>`
 | |
| 
 | |
| ```ts
 | |
| interface AttachmentResource {
 | |
| 
 | |
| }
 | |
| 
 | |
| interface UploadActionOptions {
 | |
| 
 | |
| }
 | |
| 
 | |
| api.resource<AttachmentResource>('attachments').upload();
 | |
| api.resource('attachments').upload<UploadActionOptions>();
 | |
| ```
 |