@diephp/vue-apix 0.3.2 → 0.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -5
- package/dist/model.d.ts +5 -5
- package/dist/vue-apix.cjs +1 -1
- package/dist/vue-apix.js +40 -43
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -474,6 +474,22 @@ affects watch-triggered and `refresh()`-triggered fills — the very first load
|
|
|
474
474
|
unaffected (there's nothing local to protect yet), and `reset()` is unaffected too (it's
|
|
475
475
|
an explicit, direct action, not a server response).
|
|
476
476
|
|
|
477
|
+
`lock` works even with **no `watch` at all** — a plain search box built with just
|
|
478
|
+
`immediate: false` + `lock` + a manual `refresh()` on submit keeps its typed value across
|
|
479
|
+
that `refresh()` the same way:
|
|
480
|
+
|
|
481
|
+
```ts
|
|
482
|
+
const searchForm = apix.getForm('?action=search_parcel', {
|
|
483
|
+
default: () => ({ tracking_number: null }),
|
|
484
|
+
lock: ['tracking_number'],
|
|
485
|
+
immediate: false,
|
|
486
|
+
});
|
|
487
|
+
|
|
488
|
+
// <el-input v-model="searchForm.tracking_number" />
|
|
489
|
+
// on submit: searchForm.refresh() — tracking_number survives even if the
|
|
490
|
+
// response doesn't include that field at all
|
|
491
|
+
```
|
|
492
|
+
|
|
477
493
|
### `refresh()` — the "Search" button
|
|
478
494
|
|
|
479
495
|
```ts
|
|
@@ -482,15 +498,16 @@ model.refresh();
|
|
|
482
498
|
model.refresh({ ignore: ['paginator.page'], lock: ['trackingNumber'] });
|
|
483
499
|
```
|
|
484
500
|
|
|
485
|
-
- Sends every field except `ignore`
|
|
486
|
-
`
|
|
501
|
+
- Sends every field except `ignore` and applies `lock`, cancelling a pending debounce —
|
|
502
|
+
**`watch` doesn't need to be configured at all** for this: a plain search box with
|
|
503
|
+
`immediate: false` and `lock: ['trackingNumber']`, no `watch`, still keeps its typed
|
|
504
|
+
value across `refresh()` even when the backend doesn't echo it back.
|
|
487
505
|
- `options.ignore`/`options.lock` **extend** the form-level lists for this call only —
|
|
488
506
|
handy for "Search resets to page 1": omit `paginator.page` for just this click so the
|
|
489
507
|
server defaults to page 1, without changing the form's permanent configuration.
|
|
490
508
|
- `model.reload()` is different: it re-runs the *original* fill request with no
|
|
491
|
-
field-derived payload at all — it resets the view rather than searching
|
|
492
|
-
current state.
|
|
493
|
-
- Without `watch` configured, `refresh()` simply behaves like `reload()`.
|
|
509
|
+
field-derived payload and no `lock` at all — it resets the view rather than searching
|
|
510
|
+
with the current state.
|
|
494
511
|
|
|
495
512
|
### Cleanup — no `unwatch()` needed inside a component
|
|
496
513
|
|
package/dist/model.d.ts
CHANGED
|
@@ -84,11 +84,11 @@ export declare class ApixFormModel<T = any> {
|
|
|
84
84
|
reload(url?: string): Promise<any>;
|
|
85
85
|
/**
|
|
86
86
|
* Re-send the fill request with the CURRENT state — a manual trigger for a
|
|
87
|
-
* "Search" button. Sends every
|
|
88
|
-
* `lock` fields from being overwritten by
|
|
89
|
-
* auto watch-triggered request; any pending
|
|
90
|
-
* `options.ignore`/`options.lock` extend the
|
|
91
|
-
*
|
|
87
|
+
* "Search" button. Sends every field except `ignore` (with or without
|
|
88
|
+
* `watch` configured), and protects `lock` fields from being overwritten by
|
|
89
|
+
* the response, exactly like an auto watch-triggered request; any pending
|
|
90
|
+
* debounce is cancelled. `options.ignore`/`options.lock` extend the
|
|
91
|
+
* form-level lists for this one call only.
|
|
92
92
|
*/
|
|
93
93
|
refresh(options?: RefreshOptions): Promise<any>;
|
|
94
94
|
/**
|
package/dist/vue-apix.cjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const d=require("vue");function c(i){const t=d.toRaw(i);if(t===null||typeof t!="object")return t;if(Array.isArray(t))return t.map(s=>c(s));if(t instanceof Date)return new Date(t.getTime());const e=Object.getPrototypeOf(t);if(e===Object.prototype||e===null){const s={};for(const r of Object.keys(t))s[r]=c(t[r]);return s}return t}function m(i){if(i===null||typeof i!="object")return!1;const t=Object.getPrototypeOf(i);return t===Object.prototype||t===null}function k(i,t){if(!m(t))return i===void 0?c(t):i;if(i==null)return c(t);if(!m(i))return i;for(const e of Object.keys(t))i[e]=e in i?k(i[e],t[e]):c(t[e]);return i}function f(i,t){if(i==null)return;let e=i;for(const s of t.split(".")){if(e==null)return;e=e[s]}return e}function y(i,t,e){const s=t.split(".");let r=i;for(let o=0;o<s.length-1;o++){const n=s[o];(r[n]===null||typeof r[n]!="object")&&(r[n]={}),r=r[n]}r[s[s.length-1]]=e}function x(i,t){const e={};for(const s of t){const r=f(i,s);r!==void 0&&y(e,s,c(r))}return e}function j(i){const t={};for(const[e,s]of Object.entries(i??{}))s!=null&&(t[e]=Array.isArray(s)?String(s[0]):String(s));return t}function _(i){return i&&typeof i=="object"&&typeof i.message=="string"?i.message:null}function E(i,t){return t.some(e=>e===i||i.startsWith(`${e}.`))}function R(i,t,e=""){if(e&&E(e,t))return[];if(m(i)){const s=[];for(const r of Object.keys(i))s.push(...R(i[r],t,e?`${e}.${r}`:r));return s}return Array.isArray(i)||!e?[]:[e]}function q(i,t){return t&&i&&typeof i=="object"?f(i,t):i}class g extends Error{constructor(t,e,s){super(_(e)??`Request failed with status ${t}`),this.name="ApixError",this.status=t,this.body=e,this.response=s,this.errors=e&&typeof e=="object"&&e.errors&&typeof e.errors=="object"?e.errors:{}}get isValidationError(){return this.status>=400&&this.status<500&&Object.keys(this.errors).length>0}}function F(i){return i instanceof Error&&i.name==="AbortError"}function T(i){const t=[],e=(r,o)=>{t.push(`${encodeURIComponent(r)}=${encodeURIComponent(o)}`)},s=(r,o)=>{if(r!=null){if(typeof r=="boolean")return e(o,r?"1":"0");if(r instanceof Date)return e(o,r.toISOString());if(Array.isArray(r)){r.forEach((n,a)=>s(n,`${o}[${a}]`));return}if(typeof r=="object"){for(const[n,a]of Object.entries(r))s(a,`${o}[${n}]`);return}e(o,String(r))}};for(const[r,o]of Object.entries(i))s(o,r);return t.join("&")}async function U(i){if(i.status===204)return null;const t=await i.text();if(!t)return null;try{return JSON.parse(t)}catch{return t}}class A{constructor(t,e={},s=null){this._snapshot=null,this._snapshotLocked=!1,this._ignore=[],this._lock=[],this._triggerFields=null,this._sendFields=null,this._debounce=0,this._debounceTimer=null,this._lastSent=null,this._fillAbort=null,this._transformResponse=null,this._transformRequest=null,this._deferredWatchSetup=null,this._apix=t,this._options=e,this._source=s,this._transformResponse=e.transformResponse??null,this._transformRequest=e.transformRequest??null;const r=e.default?e.default():null;if(this._state=d.reactive({data:r,errors:{},message:null,processing:!1}),this._snapshot=c(r),this._ignore=e.ignore??[],this._lock=e.lock??[],e.watch){const o=e.watch;if(!this._source)console.warn("[vue-apix] `watch` has no effect without a source URL (use apix.getForm/postForm).");else if(e.immediate===!1)this._setupWatch(o,r);else{const n=d.getCurrentScope();this._deferredWatchSetup=()=>{n?n.run(()=>this._setupWatch(o,r)):this._setupWatch(o,r)}}}}get data(){return this._state.data}set data(t){this._state.data=t}get errors(){return this._state.errors}get message(){return this._state.message}get processing(){return this._state.processing}get hasErrors(){return Object.keys(this._state.errors).length>0}get isDirty(){return JSON.stringify(this._state.data)!==JSON.stringify(this._snapshot)}get(t){return c(f(this._state.data,t))}setData(t){return this._state.data=c(t),this._proxy}error(t){const e=this._state.errors;if(e[t]!==void 0)return e[t];const s=`${t}.`;for(const r of Object.keys(e))if(r.startsWith(s))return e[r]}setErrors(t){return this._state.errors=j(t),this._proxy}clearErrors(t){if(!t)return this._state.errors={},this._proxy;for(const e of t){const s=`${e}.`;for(const r of Object.keys(this._state.errors))(r===e||r.startsWith(s))&&delete this._state.errors[r]}return this._proxy}reset(t){if(t===void 0||Array.isArray(t)&&t.length===0)return this._state.data=c(this._snapshot),this._state.errors={},this._state.message=null,this._proxy;const e=Array.isArray(t)?t:[t];if(this._state.data&&typeof this._state.data=="object")for(const s of e)y(this._state.data,s,c(f(this._snapshot,s)));return this.clearErrors(e),this._proxy}post(t,e){return this._submit("post",t,e)}put(t,e){return this._submit("put",t,e)}patch(t,e){return this._submit("patch",t,e)}delete(t,e){return this._submit("delete",t,e)}reload(t){var e;return t&&(this._source={url:t,method:((e=this._source)==null?void 0:e.method)??"get"}),this._source?this._fill():Promise.reject(new Error("[vue-apix] The model has no source URL. Use apix.getForm(url) or model.reload(url)."))}refresh(t={}){if(!this._source)return Promise.reject(new Error("[vue-apix] The model has no source URL. Use apix.getForm(url) or model.reload(url)."));if(this._triggerFields===null)return this._fill();this._debounceTimer&&(clearTimeout(this._debounceTimer),this._debounceTimer=null);const e=this._buildFillExtra(t);return this._lastSent=this._payloadJson(),this._fill(e)}transformResponse(t){return this._transformResponse=t,this._proxy}transformRequest(t){return this._transformRequest=t,this._proxy}async _fill(t={}){var o,n,a,h,l;const e=this._source;(o=this._fillAbort)==null||o.abort();const s=new AbortController;this._fillAbort=s,this._state.processing=!0;const r={signal:s.signal};e.method==="get"?r.params={...this._options.params,...t.params}:(r.params=this._options.params,r.data=t.data!==void 0?t.data:this._options.data);try{const u=await this._apix.request(e.method,e.url,r);let p=q(u,this._options.path);if(this._transformResponse){const b=c(p);p=this._transformResponse(b,u)??b}return this._applyFill(p,t.preserve??null),this._state.message=_(u),this._state.errors={},(a=(n=this._options).onSuccess)==null||a.call(n,u,this._proxy),u}catch(u){throw F(u)||(this._applyError(u),(l=(h=this._options).onError)==null||l.call(h,u,this._proxy)),u}finally{this._fillAbort===s&&(this._fillAbort=null,this._state.processing=!1)}}_applyFill(t,e){let s=c(t);this._options.mergeDefaults!==!1&&this._options.default&&(s=k(s,this._options.default()));const r=this._snapshotLocked?null:c(s);if(e&&e.length&&s&&typeof s=="object"&&this._state.data&&typeof this._state.data=="object")for(const o of e){const n=f(this._state.data,o);n!==void 0&&y(s,o,c(n))}this._state.data=s,this._snapshotLocked||(this._snapshot=r,this._snapshotLocked=!0),this._syncLastSent()}_applyError(t){t instanceof g&&(this._state.message=_(t.body)??t.message,t.isValidationError&&(this._state.errors=j(t.errors)))}async _submit(t,e,s={}){var n;const r=e??((n=this._source)==null?void 0:n.url);if(!r)throw new Error(`[vue-apix] The model has no URL. Pass one explicitly: model.${t}(url).`);let o=s.data!==void 0?s.data:s.only?x(this._state.data,s.only):this._state.data??void 0;if(s.data===void 0&&this._transformRequest&&o!==void 0){const a=c(o);o=this._transformRequest(a)??a}this._state.processing=!0,this._state.errors={},this._state.message=null;try{const a=await this._apix.request(t,r,{data:o,params:s.params,headers:s.headers});return this._state.message=_(a),a}catch(a){throw this._applyError(a),a}finally{this._state.processing=!1}}_setupWatch(t,e){const s=t===!0?{}:t,r=s.fields;this._sendFields=R(e??{},this._ignore);const o=r??this._sendFields;this._triggerFields=o,this._debounce=s.debounce??0,this._syncLastSent();const n=o.map(h=>()=>f(this._state.data,h)),a=r?s.deep??!1:!0;d.watch(n,()=>this._onWatchTrigger(),{deep:a})}_onWatchTrigger(){this._payloadJson()!==this._lastSent&&(this._debounceTimer&&clearTimeout(this._debounceTimer),this._debounce>0?this._debounceTimer=setTimeout(()=>this._sendWatchRequest(),this._debounce):this._sendWatchRequest())}_sendWatchRequest(){this._debounceTimer=null,this._source&&(this._lastSent=this._payloadJson(),this._fill(this._buildFillExtra()).catch(()=>{}))}_buildFillExtra(t={}){const e=t.lock?[...this._lock,...t.lock]:this._lock,s=t.ignore?(this._sendFields??[]).filter(o=>!E(o,t.ignore)):this._sendFields??[];let r=x(this._state.data,s);return this._transformRequest&&(r=this._transformRequest(r)??r),this._source.method==="get"?{params:r,preserve:e}:{data:r,preserve:e}}_payloadJson(){const e=(this._triggerFields??[]).map(s=>f(this._state.data,s));return JSON.stringify(e)??"undefined"}_syncLastSent(){this._lastSent=this._payloadJson()}}function w(i,t={},e=null){const s=new A(i,t,e),r=new Proxy(s,{get(o,n){if(typeof n=="symbol"||n in o)return Reflect.get(o,n);const a=o._state.data;if(a&&typeof a=="object")return a[n]},set(o,n,a){if(typeof n=="symbol"||n in o)return Reflect.set(o,n,a);const h=o._state.data;return h&&typeof h=="object"?(h[n]=a,!0):(o._state.data={[n]:a},!0)},has(o,n){if(n in o)return!0;const a=o._state.data;return!!a&&typeof a=="object"&&n in a}});return s._proxy=r,e&&t.immediate!==!1&&r.reload().finally(()=>{var o;(o=s._deferredWatchSetup)==null||o.call(s),s._deferredWatchSetup=null}).catch(()=>{}),r}class S{constructor(t={}){this.baseUrl="",this.headers={},this.processingHooks=[],this.errorHooks=[],this.bodyTransformer=null,this.active=0,t.baseUrl&&this.setBaseUrl(t.baseUrl),t.headers&&this.setHeader(t.headers),t.credentials&&(this.credentials=t.credentials)}setBaseUrl(t){return this.baseUrl=t.replace(/\/+$/,""),this}setHeader(t){return Object.assign(this.headers,t),this}setCredentials(t){return this.credentials=t,this}onProcessing(t){return this.processingHooks.push(t),()=>{this.processingHooks=this.processingHooks.filter(e=>e!==t)}}onError(t){return this.errorHooks.push(t),()=>{this.errorHooks=this.errorHooks.filter(e=>e!==t)}}transformResponse(t){return this.bodyTransformer=t,this}async request(t,e,s={}){let r=/^https?:\/\//i.test(e)?e:this.baseUrl+e;if(s.params){const h=T(s.params);h&&(r+=(r.includes("?")?"&":"?")+h)}const o={accept:"application/json","x-requested-with":"XMLHttpRequest"};for(const[h,l]of Object.entries(this.headers)){const u=typeof l=="function"?l():l;u!=null&&(o[h.toLowerCase()]=u)}for(const[h,l]of Object.entries(s.headers??{}))o[h.toLowerCase()]=l;const n={method:t.toUpperCase(),headers:o,signal:s.signal};this.credentials&&(n.credentials=this.credentials),s.data!==void 0&&t!=="get"&&(typeof FormData<"u"&&s.data instanceof FormData?(delete o["content-type"],n.body=s.data):(o["content-type"]??(o["content-type"]="application/json"),n.body=JSON.stringify(s.data)));const a={method:t,url:r,options:s};this.trackStart();try{const h=await fetch(r,n);let l=await U(h);if(this.bodyTransformer&&(l=this.bodyTransformer(l,a)??l),!h.ok)throw new g(h.status,l,h);return l}catch(h){throw F(h)?h:this.emitError(h,a)}finally{this.trackEnd()}}get(t,e,s={}){return this.request("get",t,e?{...s,params:e}:s)}post(t,e,s={}){return this.request("post",t,e!==void 0?{...s,data:e}:s)}put(t,e,s={}){return this.request("put",t,e!==void 0?{...s,data:e}:s)}patch(t,e,s={}){return this.request("patch",t,e!==void 0?{...s,data:e}:s)}delete(t,e,s={}){return this.request("delete",t,e!==void 0?{...s,data:e}:s)}form(t,e={}){return w(this,{...e,default:typeof t=="function"?t:()=>c(t)})}getForm(t,e){return this.createFormModel("get",t,e)}postForm(t,e){return this.createFormModel("post",t,e)}createFormModel(t,e,s){const r=typeof s=="string"?{path:s}:{...s??{}};return w(this,r,{url:e,method:t})}trackStart(){++this.active===1&&this.emitProcessing(!0)}trackEnd(){--this.active===0&&this.emitProcessing(!1)}emitProcessing(t){for(const e of this.processingHooks)try{e(t)}catch{}}emitError(t,e){let s=t;for(const r of this.errorHooks)try{const o=r(s,e);o instanceof Error&&(s=o)}catch{}return s}}function v(i={}){return new S(i)}const O=v();exports.Apix=S;exports.ApixError=g;exports.ApixFormModel=A;exports.apix=O;exports.createApix=v;exports.default=O;
|
|
1
|
+
"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const d=require("vue");function c(i){const t=d.toRaw(i);if(t===null||typeof t!="object")return t;if(Array.isArray(t))return t.map(s=>c(s));if(t instanceof Date)return new Date(t.getTime());const e=Object.getPrototypeOf(t);if(e===Object.prototype||e===null){const s={};for(const r of Object.keys(t))s[r]=c(t[r]);return s}return t}function m(i){if(i===null||typeof i!="object")return!1;const t=Object.getPrototypeOf(i);return t===Object.prototype||t===null}function E(i,t){if(!m(t))return i===void 0?c(t):i;if(i==null)return c(t);if(!m(i))return i;for(const e of Object.keys(t))i[e]=e in i?E(i[e],t[e]):c(t[e]);return i}function f(i,t){if(i==null)return;let e=i;for(const s of t.split(".")){if(e==null)return;e=e[s]}return e}function y(i,t,e){const s=t.split(".");let r=i;for(let o=0;o<s.length-1;o++){const n=s[o];(r[n]===null||typeof r[n]!="object")&&(r[n]={}),r=r[n]}r[s[s.length-1]]=e}function j(i,t){const e={};for(const s of t){const r=f(i,s);r!==void 0&&y(e,s,c(r))}return e}function w(i){const t={};for(const[e,s]of Object.entries(i??{}))s!=null&&(t[e]=Array.isArray(s)?String(s[0]):String(s));return t}function _(i){return i&&typeof i=="object"&&typeof i.message=="string"?i.message:null}function R(i,t){return t.some(e=>e===i||i.startsWith(`${e}.`))}function g(i,t,e=""){if(e&&R(e,t))return[];if(m(i)){const s=[];for(const r of Object.keys(i))s.push(...g(i[r],t,e?`${e}.${r}`:r));return s}return Array.isArray(i)||!e?[]:[e]}function q(i,t){return t&&i&&typeof i=="object"?f(i,t):i}class b extends Error{constructor(t,e,s){super(_(e)??`Request failed with status ${t}`),this.name="ApixError",this.status=t,this.body=e,this.response=s,this.errors=e&&typeof e=="object"&&e.errors&&typeof e.errors=="object"?e.errors:{}}get isValidationError(){return this.status>=400&&this.status<500&&Object.keys(this.errors).length>0}}function A(i){return i instanceof Error&&i.name==="AbortError"}function T(i){const t=[],e=(r,o)=>{t.push(`${encodeURIComponent(r)}=${encodeURIComponent(o)}`)},s=(r,o)=>{if(r!=null){if(typeof r=="boolean")return e(o,r?"1":"0");if(r instanceof Date)return e(o,r.toISOString());if(Array.isArray(r)){r.forEach((n,a)=>s(n,`${o}[${a}]`));return}if(typeof r=="object"){for(const[n,a]of Object.entries(r))s(a,`${o}[${n}]`);return}e(o,String(r))}};for(const[r,o]of Object.entries(i))s(o,r);return t.join("&")}async function U(i){if(i.status===204)return null;const t=await i.text();if(!t)return null;try{return JSON.parse(t)}catch{return t}}class F{constructor(t,e={},s=null){this._snapshot=null,this._snapshotLocked=!1,this._ignore=[],this._lock=[],this._triggerFields=null,this._sendFields=null,this._debounce=0,this._debounceTimer=null,this._lastSent=null,this._fillAbort=null,this._transformResponse=null,this._transformRequest=null,this._deferredWatchSetup=null,this._apix=t,this._options=e,this._source=s,this._transformResponse=e.transformResponse??null,this._transformRequest=e.transformRequest??null;const r=e.default?e.default():null;if(this._state=d.reactive({data:r,errors:{},message:null,processing:!1}),this._snapshot=c(r),this._ignore=e.ignore??[],this._lock=e.lock??[],this._sendFields=g(r??{},this._ignore),e.watch){const o=e.watch;if(!this._source)console.warn("[vue-apix] `watch` has no effect without a source URL (use apix.getForm/postForm).");else if(e.immediate===!1)this._setupWatch(o,r);else{const n=d.getCurrentScope();this._deferredWatchSetup=()=>{n?n.run(()=>this._setupWatch(o,r)):this._setupWatch(o,r)}}}}get data(){return this._state.data}set data(t){this._state.data=t}get errors(){return this._state.errors}get message(){return this._state.message}get processing(){return this._state.processing}get hasErrors(){return Object.keys(this._state.errors).length>0}get isDirty(){return JSON.stringify(this._state.data)!==JSON.stringify(this._snapshot)}get(t){return c(f(this._state.data,t))}setData(t){return this._state.data=c(t),this._proxy}error(t){const e=this._state.errors;if(e[t]!==void 0)return e[t];const s=`${t}.`;for(const r of Object.keys(e))if(r.startsWith(s))return e[r]}setErrors(t){return this._state.errors=w(t),this._proxy}clearErrors(t){if(!t)return this._state.errors={},this._proxy;for(const e of t){const s=`${e}.`;for(const r of Object.keys(this._state.errors))(r===e||r.startsWith(s))&&delete this._state.errors[r]}return this._proxy}reset(t){if(t===void 0||Array.isArray(t)&&t.length===0)return this._state.data=c(this._snapshot),this._state.errors={},this._state.message=null,this._proxy;const e=Array.isArray(t)?t:[t];if(this._state.data&&typeof this._state.data=="object")for(const s of e)y(this._state.data,s,c(f(this._snapshot,s)));return this.clearErrors(e),this._proxy}post(t,e){return this._submit("post",t,e)}put(t,e){return this._submit("put",t,e)}patch(t,e){return this._submit("patch",t,e)}delete(t,e){return this._submit("delete",t,e)}reload(t){var e;return t&&(this._source={url:t,method:((e=this._source)==null?void 0:e.method)??"get"}),this._source?this._fill():Promise.reject(new Error("[vue-apix] The model has no source URL. Use apix.getForm(url) or model.reload(url)."))}refresh(t={}){if(!this._source)return Promise.reject(new Error("[vue-apix] The model has no source URL. Use apix.getForm(url) or model.reload(url)."));this._debounceTimer&&(clearTimeout(this._debounceTimer),this._debounceTimer=null);const e=this._buildFillExtra(t);return this._lastSent=this._payloadJson(),this._fill(e)}transformResponse(t){return this._transformResponse=t,this._proxy}transformRequest(t){return this._transformRequest=t,this._proxy}async _fill(t={}){var o,n,a,h,u;const e=this._source;(o=this._fillAbort)==null||o.abort();const s=new AbortController;this._fillAbort=s,this._state.processing=!0;const r={signal:s.signal};e.method==="get"?r.params={...this._options.params,...t.params}:(r.params=this._options.params,r.data=t.data!==void 0?t.data:this._options.data);try{const l=await this._apix.request(e.method,e.url,r);let p=q(l,this._options.path);if(this._transformResponse){const x=c(p);p=this._transformResponse(x,l)??x}return this._applyFill(p,t.preserve??null),this._state.message=_(l),this._state.errors={},(a=(n=this._options).onSuccess)==null||a.call(n,l,this._proxy),l}catch(l){throw A(l)||(this._applyError(l),(u=(h=this._options).onError)==null||u.call(h,l,this._proxy)),l}finally{this._fillAbort===s&&(this._fillAbort=null,this._state.processing=!1)}}_applyFill(t,e){let s=c(t);this._options.mergeDefaults!==!1&&this._options.default&&(s=E(s,this._options.default()));const r=this._snapshotLocked?null:c(s);if(e&&e.length&&s&&typeof s=="object"&&this._state.data&&typeof this._state.data=="object")for(const o of e){const n=f(this._state.data,o);n!==void 0&&y(s,o,c(n))}this._state.data=s,this._snapshotLocked||(this._snapshot=r,this._snapshotLocked=!0),this._syncLastSent()}_applyError(t){t instanceof b&&(this._state.message=_(t.body)??t.message,t.isValidationError&&(this._state.errors=w(t.errors)))}async _submit(t,e,s={}){var n;const r=e??((n=this._source)==null?void 0:n.url);if(!r)throw new Error(`[vue-apix] The model has no URL. Pass one explicitly: model.${t}(url).`);let o=s.data!==void 0?s.data:s.only?j(this._state.data,s.only):this._state.data??void 0;if(s.data===void 0&&this._transformRequest&&o!==void 0){const a=c(o);o=this._transformRequest(a)??a}this._state.processing=!0,this._state.errors={},this._state.message=null;try{const a=await this._apix.request(t,r,{data:o,params:s.params,headers:s.headers});return this._state.message=_(a),a}catch(a){throw this._applyError(a),a}finally{this._state.processing=!1}}_setupWatch(t,e){const s=t===!0?{}:t,r=s.fields,o=r??this._sendFields??g(e??{},this._ignore);this._triggerFields=o,this._debounce=s.debounce??0,this._syncLastSent();const n=o.map(h=>()=>f(this._state.data,h)),a=r?s.deep??!1:!0;d.watch(n,()=>this._onWatchTrigger(),{deep:a})}_onWatchTrigger(){this._payloadJson()!==this._lastSent&&(this._debounceTimer&&clearTimeout(this._debounceTimer),this._debounce>0?this._debounceTimer=setTimeout(()=>this._sendWatchRequest(),this._debounce):this._sendWatchRequest())}_sendWatchRequest(){this._debounceTimer=null,this._source&&(this._lastSent=this._payloadJson(),this._fill(this._buildFillExtra()).catch(()=>{}))}_buildFillExtra(t={}){const e=t.lock?[...this._lock,...t.lock]:this._lock,s=t.ignore?(this._sendFields??[]).filter(o=>!R(o,t.ignore)):this._sendFields??[];let r=j(this._state.data,s);return this._transformRequest&&(r=this._transformRequest(r)??r),this._source.method==="get"?{params:r,preserve:e}:{data:r,preserve:e}}_payloadJson(){const e=(this._triggerFields??[]).map(s=>f(this._state.data,s));return JSON.stringify(e)??"undefined"}_syncLastSent(){this._lastSent=this._payloadJson()}}function k(i,t={},e=null){const s=new F(i,t,e),r=new Proxy(s,{get(o,n){if(typeof n=="symbol"||n in o)return Reflect.get(o,n);const a=o._state.data;if(a&&typeof a=="object")return a[n]},set(o,n,a){if(typeof n=="symbol"||n in o)return Reflect.set(o,n,a);const h=o._state.data;return h&&typeof h=="object"?(h[n]=a,!0):(o._state.data={[n]:a},!0)},has(o,n){if(n in o)return!0;const a=o._state.data;return!!a&&typeof a=="object"&&n in a}});return s._proxy=r,e&&t.immediate!==!1&&r.reload().finally(()=>{var o;(o=s._deferredWatchSetup)==null||o.call(s),s._deferredWatchSetup=null}).catch(()=>{}),r}class S{constructor(t={}){this.baseUrl="",this.headers={},this.processingHooks=[],this.errorHooks=[],this.bodyTransformer=null,this.active=0,t.baseUrl&&this.setBaseUrl(t.baseUrl),t.headers&&this.setHeader(t.headers),t.credentials&&(this.credentials=t.credentials)}setBaseUrl(t){return this.baseUrl=t.replace(/\/+$/,""),this}setHeader(t){return Object.assign(this.headers,t),this}setCredentials(t){return this.credentials=t,this}onProcessing(t){return this.processingHooks.push(t),()=>{this.processingHooks=this.processingHooks.filter(e=>e!==t)}}onError(t){return this.errorHooks.push(t),()=>{this.errorHooks=this.errorHooks.filter(e=>e!==t)}}transformResponse(t){return this.bodyTransformer=t,this}async request(t,e,s={}){let r=/^https?:\/\//i.test(e)?e:this.baseUrl+e;if(s.params){const h=T(s.params);h&&(r+=(r.includes("?")?"&":"?")+h)}const o={accept:"application/json","x-requested-with":"XMLHttpRequest"};for(const[h,u]of Object.entries(this.headers)){const l=typeof u=="function"?u():u;l!=null&&(o[h.toLowerCase()]=l)}for(const[h,u]of Object.entries(s.headers??{}))o[h.toLowerCase()]=u;const n={method:t.toUpperCase(),headers:o,signal:s.signal};this.credentials&&(n.credentials=this.credentials),s.data!==void 0&&t!=="get"&&(typeof FormData<"u"&&s.data instanceof FormData?(delete o["content-type"],n.body=s.data):(o["content-type"]??(o["content-type"]="application/json"),n.body=JSON.stringify(s.data)));const a={method:t,url:r,options:s};this.trackStart();try{const h=await fetch(r,n);let u=await U(h);if(this.bodyTransformer&&(u=this.bodyTransformer(u,a)??u),!h.ok)throw new b(h.status,u,h);return u}catch(h){throw A(h)?h:this.emitError(h,a)}finally{this.trackEnd()}}get(t,e,s={}){return this.request("get",t,e?{...s,params:e}:s)}post(t,e,s={}){return this.request("post",t,e!==void 0?{...s,data:e}:s)}put(t,e,s={}){return this.request("put",t,e!==void 0?{...s,data:e}:s)}patch(t,e,s={}){return this.request("patch",t,e!==void 0?{...s,data:e}:s)}delete(t,e,s={}){return this.request("delete",t,e!==void 0?{...s,data:e}:s)}form(t,e={}){return k(this,{...e,default:typeof t=="function"?t:()=>c(t)})}getForm(t,e){return this.createFormModel("get",t,e)}postForm(t,e){return this.createFormModel("post",t,e)}createFormModel(t,e,s){const r=typeof s=="string"?{path:s}:{...s??{}};return k(this,r,{url:e,method:t})}trackStart(){++this.active===1&&this.emitProcessing(!0)}trackEnd(){--this.active===0&&this.emitProcessing(!1)}emitProcessing(t){for(const e of this.processingHooks)try{e(t)}catch{}}emitError(t,e){let s=t;for(const r of this.errorHooks)try{const o=r(s,e);o instanceof Error&&(s=o)}catch{}return s}}function v(i={}){return new S(i)}const O=v();exports.Apix=S;exports.ApixError=b;exports.ApixFormModel=F;exports.apix=O;exports.createApix=v;exports.default=O;
|
package/dist/vue-apix.js
CHANGED
|
@@ -17,13 +17,13 @@ function p(i) {
|
|
|
17
17
|
const t = Object.getPrototypeOf(i);
|
|
18
18
|
return t === Object.prototype || t === null;
|
|
19
19
|
}
|
|
20
|
-
function
|
|
20
|
+
function w(i, t) {
|
|
21
21
|
if (!p(t))
|
|
22
22
|
return i === void 0 ? c(t) : i;
|
|
23
23
|
if (i == null) return c(t);
|
|
24
24
|
if (!p(i)) return i;
|
|
25
25
|
for (const e of Object.keys(t))
|
|
26
|
-
i[e] = e in i ?
|
|
26
|
+
i[e] = e in i ? w(i[e], t[e]) : c(t[e]);
|
|
27
27
|
return i;
|
|
28
28
|
}
|
|
29
29
|
function f(i, t) {
|
|
@@ -44,7 +44,7 @@ function m(i, t, e) {
|
|
|
44
44
|
}
|
|
45
45
|
r[s[s.length - 1]] = e;
|
|
46
46
|
}
|
|
47
|
-
function
|
|
47
|
+
function b(i, t) {
|
|
48
48
|
const e = {};
|
|
49
49
|
for (const s of t) {
|
|
50
50
|
const r = f(i, s);
|
|
@@ -52,7 +52,7 @@ function g(i, t) {
|
|
|
52
52
|
}
|
|
53
53
|
return e;
|
|
54
54
|
}
|
|
55
|
-
function
|
|
55
|
+
function j(i) {
|
|
56
56
|
const t = {};
|
|
57
57
|
for (const [e, s] of Object.entries(i ?? {}))
|
|
58
58
|
s != null && (t[e] = Array.isArray(s) ? String(s[0]) : String(s));
|
|
@@ -61,15 +61,15 @@ function b(i) {
|
|
|
61
61
|
function d(i) {
|
|
62
62
|
return i && typeof i == "object" && typeof i.message == "string" ? i.message : null;
|
|
63
63
|
}
|
|
64
|
-
function
|
|
64
|
+
function k(i, t) {
|
|
65
65
|
return t.some((e) => e === i || i.startsWith(`${e}.`));
|
|
66
66
|
}
|
|
67
|
-
function
|
|
68
|
-
if (e &&
|
|
67
|
+
function y(i, t, e = "") {
|
|
68
|
+
if (e && k(e, t)) return [];
|
|
69
69
|
if (p(i)) {
|
|
70
70
|
const s = [];
|
|
71
71
|
for (const r of Object.keys(i))
|
|
72
|
-
s.push(...
|
|
72
|
+
s.push(...y(i[r], t, e ? `${e}.${r}` : r));
|
|
73
73
|
return s;
|
|
74
74
|
}
|
|
75
75
|
return Array.isArray(i) || !e ? [] : [e];
|
|
@@ -128,7 +128,7 @@ class U {
|
|
|
128
128
|
constructor(t, e = {}, s = null) {
|
|
129
129
|
this._snapshot = null, this._snapshotLocked = !1, this._ignore = [], this._lock = [], this._triggerFields = null, this._sendFields = null, this._debounce = 0, this._debounceTimer = null, this._lastSent = null, this._fillAbort = null, this._transformResponse = null, this._transformRequest = null, this._deferredWatchSetup = null, this._apix = t, this._options = e, this._source = s, this._transformResponse = e.transformResponse ?? null, this._transformRequest = e.transformRequest ?? null;
|
|
130
130
|
const r = e.default ? e.default() : null;
|
|
131
|
-
if (this._state = O({ data: r, errors: {}, message: null, processing: !1 }), this._snapshot = c(r), this._ignore = e.ignore ?? [], this._lock = e.lock ?? [], e.watch) {
|
|
131
|
+
if (this._state = O({ data: r, errors: {}, message: null, processing: !1 }), this._snapshot = c(r), this._ignore = e.ignore ?? [], this._lock = e.lock ?? [], this._sendFields = y(r ?? {}, this._ignore), e.watch) {
|
|
132
132
|
const o = e.watch;
|
|
133
133
|
if (!this._source)
|
|
134
134
|
console.warn("[vue-apix] `watch` has no effect without a source URL (use apix.getForm/postForm).");
|
|
@@ -191,7 +191,7 @@ class U {
|
|
|
191
191
|
if (r.startsWith(s)) return e[r];
|
|
192
192
|
}
|
|
193
193
|
setErrors(t) {
|
|
194
|
-
return this._state.errors =
|
|
194
|
+
return this._state.errors = j(t), this._proxy;
|
|
195
195
|
}
|
|
196
196
|
/** Clear all errors, or only the given keys (including their `key.*` sub-errors). */
|
|
197
197
|
clearErrors(t) {
|
|
@@ -240,18 +240,17 @@ class U {
|
|
|
240
240
|
}
|
|
241
241
|
/**
|
|
242
242
|
* Re-send the fill request with the CURRENT state — a manual trigger for a
|
|
243
|
-
* "Search" button. Sends every
|
|
244
|
-
* `lock` fields from being overwritten by
|
|
245
|
-
* auto watch-triggered request; any pending
|
|
246
|
-
* `options.ignore`/`options.lock` extend the
|
|
247
|
-
*
|
|
243
|
+
* "Search" button. Sends every field except `ignore` (with or without
|
|
244
|
+
* `watch` configured), and protects `lock` fields from being overwritten by
|
|
245
|
+
* the response, exactly like an auto watch-triggered request; any pending
|
|
246
|
+
* debounce is cancelled. `options.ignore`/`options.lock` extend the
|
|
247
|
+
* form-level lists for this one call only.
|
|
248
248
|
*/
|
|
249
249
|
refresh(t = {}) {
|
|
250
250
|
if (!this._source)
|
|
251
251
|
return Promise.reject(
|
|
252
252
|
new Error("[vue-apix] The model has no source URL. Use apix.getForm(url) or model.reload(url).")
|
|
253
253
|
);
|
|
254
|
-
if (this._triggerFields === null) return this._fill();
|
|
255
254
|
this._debounceTimer && (clearTimeout(this._debounceTimer), this._debounceTimer = null);
|
|
256
255
|
const e = this._buildFillExtra(t);
|
|
257
256
|
return this._lastSent = this._payloadJson(), this._fill(e);
|
|
@@ -277,7 +276,7 @@ class U {
|
|
|
277
276
|
// --- internals ----------------------------------------------------------------------
|
|
278
277
|
/** @internal */
|
|
279
278
|
async _fill(t = {}) {
|
|
280
|
-
var o, n, a, h,
|
|
279
|
+
var o, n, a, h, u;
|
|
281
280
|
const e = this._source;
|
|
282
281
|
(o = this._fillAbort) == null || o.abort();
|
|
283
282
|
const s = new AbortController();
|
|
@@ -285,22 +284,22 @@ class U {
|
|
|
285
284
|
const r = { signal: s.signal };
|
|
286
285
|
e.method === "get" ? r.params = { ...this._options.params, ...t.params } : (r.params = this._options.params, r.data = t.data !== void 0 ? t.data : this._options.data);
|
|
287
286
|
try {
|
|
288
|
-
const
|
|
289
|
-
let _ = v(
|
|
287
|
+
const l = await this._apix.request(e.method, e.url, r);
|
|
288
|
+
let _ = v(l, this._options.path);
|
|
290
289
|
if (this._transformResponse) {
|
|
291
|
-
const
|
|
292
|
-
_ = this._transformResponse(
|
|
290
|
+
const g = c(_);
|
|
291
|
+
_ = this._transformResponse(g, l) ?? g;
|
|
293
292
|
}
|
|
294
|
-
return this._applyFill(_, t.preserve ?? null), this._state.message = d(
|
|
295
|
-
} catch (
|
|
296
|
-
throw E(
|
|
293
|
+
return this._applyFill(_, t.preserve ?? null), this._state.message = d(l), this._state.errors = {}, (a = (n = this._options).onSuccess) == null || a.call(n, l, this._proxy), l;
|
|
294
|
+
} catch (l) {
|
|
295
|
+
throw E(l) || (this._applyError(l), (u = (h = this._options).onError) == null || u.call(h, l, this._proxy)), l;
|
|
297
296
|
} finally {
|
|
298
297
|
this._fillAbort === s && (this._fillAbort = null, this._state.processing = !1);
|
|
299
298
|
}
|
|
300
299
|
}
|
|
301
300
|
_applyFill(t, e) {
|
|
302
301
|
let s = c(t);
|
|
303
|
-
this._options.mergeDefaults !== !1 && this._options.default && (s =
|
|
302
|
+
this._options.mergeDefaults !== !1 && this._options.default && (s = w(s, this._options.default()));
|
|
304
303
|
const r = this._snapshotLocked ? null : c(s);
|
|
305
304
|
if (e && e.length && s && typeof s == "object" && this._state.data && typeof this._state.data == "object")
|
|
306
305
|
for (const o of e) {
|
|
@@ -310,14 +309,14 @@ class U {
|
|
|
310
309
|
this._state.data = s, this._snapshotLocked || (this._snapshot = r, this._snapshotLocked = !0), this._syncLastSent();
|
|
311
310
|
}
|
|
312
311
|
_applyError(t) {
|
|
313
|
-
t instanceof R && (this._state.message = d(t.body) ?? t.message, t.isValidationError && (this._state.errors =
|
|
312
|
+
t instanceof R && (this._state.message = d(t.body) ?? t.message, t.isValidationError && (this._state.errors = j(t.errors)));
|
|
314
313
|
}
|
|
315
314
|
async _submit(t, e, s = {}) {
|
|
316
315
|
var n;
|
|
317
316
|
const r = e ?? ((n = this._source) == null ? void 0 : n.url);
|
|
318
317
|
if (!r)
|
|
319
318
|
throw new Error(`[vue-apix] The model has no URL. Pass one explicitly: model.${t}(url).`);
|
|
320
|
-
let o = s.data !== void 0 ? s.data : s.only ?
|
|
319
|
+
let o = s.data !== void 0 ? s.data : s.only ? b(this._state.data, s.only) : this._state.data ?? void 0;
|
|
321
320
|
if (s.data === void 0 && this._transformRequest && o !== void 0) {
|
|
322
321
|
const a = c(o);
|
|
323
322
|
o = this._transformRequest(a) ?? a;
|
|
@@ -344,9 +343,7 @@ class U {
|
|
|
344
343
|
* that's what determines which fields exist, regardless of timing.
|
|
345
344
|
*/
|
|
346
345
|
_setupWatch(t, e) {
|
|
347
|
-
const s = t === !0 ? {} : t, r = s.fields;
|
|
348
|
-
this._sendFields = k(e ?? {}, this._ignore);
|
|
349
|
-
const o = r ?? this._sendFields;
|
|
346
|
+
const s = t === !0 ? {} : t, r = s.fields, o = r ?? this._sendFields ?? y(e ?? {}, this._ignore);
|
|
350
347
|
this._triggerFields = o, this._debounce = s.debounce ?? 0, this._syncLastSent();
|
|
351
348
|
const n = o.map((h) => () => f(this._state.data, h)), a = r ? s.deep ?? !1 : !0;
|
|
352
349
|
q(n, () => this._onWatchTrigger(), { deep: a });
|
|
@@ -360,8 +357,8 @@ class U {
|
|
|
360
357
|
}
|
|
361
358
|
/** Build the fill() extra for a watch/refresh request from the current state. */
|
|
362
359
|
_buildFillExtra(t = {}) {
|
|
363
|
-
const e = t.lock ? [...this._lock, ...t.lock] : this._lock, s = t.ignore ? (this._sendFields ?? []).filter((o) => !
|
|
364
|
-
let r =
|
|
360
|
+
const e = t.lock ? [...this._lock, ...t.lock] : this._lock, s = t.ignore ? (this._sendFields ?? []).filter((o) => !k(o, t.ignore)) : this._sendFields ?? [];
|
|
361
|
+
let r = b(this._state.data, s);
|
|
365
362
|
return this._transformRequest && (r = this._transformRequest(r) ?? r), this._source.method === "get" ? { params: r, preserve: e } : { data: r, preserve: e };
|
|
366
363
|
}
|
|
367
364
|
_payloadJson() {
|
|
@@ -372,7 +369,7 @@ class U {
|
|
|
372
369
|
this._lastSent = this._payloadJson();
|
|
373
370
|
}
|
|
374
371
|
}
|
|
375
|
-
function
|
|
372
|
+
function x(i, t = {}, e = null) {
|
|
376
373
|
const s = new U(i, t, e), r = new Proxy(s, {
|
|
377
374
|
get(o, n) {
|
|
378
375
|
if (typeof n == "symbol" || n in o) return Reflect.get(o, n);
|
|
@@ -446,21 +443,21 @@ class W {
|
|
|
446
443
|
accept: "application/json",
|
|
447
444
|
"x-requested-with": "XMLHttpRequest"
|
|
448
445
|
};
|
|
449
|
-
for (const [h,
|
|
450
|
-
const
|
|
451
|
-
|
|
446
|
+
for (const [h, u] of Object.entries(this.headers)) {
|
|
447
|
+
const l = typeof u == "function" ? u() : u;
|
|
448
|
+
l != null && (o[h.toLowerCase()] = l);
|
|
452
449
|
}
|
|
453
|
-
for (const [h,
|
|
454
|
-
o[h.toLowerCase()] =
|
|
450
|
+
for (const [h, u] of Object.entries(s.headers ?? {}))
|
|
451
|
+
o[h.toLowerCase()] = u;
|
|
455
452
|
const n = { method: t.toUpperCase(), headers: o, signal: s.signal };
|
|
456
453
|
this.credentials && (n.credentials = this.credentials), s.data !== void 0 && t !== "get" && (typeof FormData < "u" && s.data instanceof FormData ? (delete o["content-type"], n.body = s.data) : (o["content-type"] ?? (o["content-type"] = "application/json"), n.body = JSON.stringify(s.data)));
|
|
457
454
|
const a = { method: t, url: r, options: s };
|
|
458
455
|
this.trackStart();
|
|
459
456
|
try {
|
|
460
457
|
const h = await fetch(r, n);
|
|
461
|
-
let
|
|
462
|
-
if (this.bodyTransformer && (
|
|
463
|
-
return
|
|
458
|
+
let u = await T(h);
|
|
459
|
+
if (this.bodyTransformer && (u = this.bodyTransformer(u, a) ?? u), !h.ok) throw new R(h.status, u, h);
|
|
460
|
+
return u;
|
|
464
461
|
} catch (h) {
|
|
465
462
|
throw E(h) ? h : this.emitError(h, a);
|
|
466
463
|
} finally {
|
|
@@ -486,7 +483,7 @@ class W {
|
|
|
486
483
|
// --- form models -----------------------------------------------------------
|
|
487
484
|
/** Create a form model without any request (like Inertia's useForm). */
|
|
488
485
|
form(t, e = {}) {
|
|
489
|
-
return
|
|
486
|
+
return x(this, { ...e, default: typeof t == "function" ? t : () => c(t) });
|
|
490
487
|
}
|
|
491
488
|
/** Create a form model and fill it with a GET request. */
|
|
492
489
|
getForm(t, e) {
|
|
@@ -498,7 +495,7 @@ class W {
|
|
|
498
495
|
}
|
|
499
496
|
createFormModel(t, e, s) {
|
|
500
497
|
const r = typeof s == "string" ? { path: s } : { ...s ?? {} };
|
|
501
|
-
return
|
|
498
|
+
return x(this, r, { url: e, method: t });
|
|
502
499
|
}
|
|
503
500
|
// --- internals --------------------------------------------------------------
|
|
504
501
|
trackStart() {
|