@pinia-orm/axios-edge 1.7.1-28257628.bbb8bab

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022-present Gregor Becker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,96 @@
+[![Pinia ORM banner](./.github/assets/banner.png)](https://github.com/storm-tail/pinia-orm)
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
+[![Coverage][code-coverage-src]][code-coverage-href]
+[![License][license-src]][license-href]
+
+# Welcome to pinia-orm
+
+> Intuitive, type safe and flexible ORM for Pinia based on [Vuex ORM Next](https://github.com/vuex-orm/vuex-orm-next)
+
+- [✨  Release Notes](https://pinia-orm.codedredd.de/changelog)
+- [📖  Documentation](https://pinia-orm.codedredd.de)
+- [👾  Playground](https://pinia-orm-play.codedredd.de)
+
+## Migration from vuex-orm
+
+You want to migrate from vuex to pinia and with it vuex-orm to pinia-orm but you don't know yet?
+Well maybe this table will help you to decide. This comparison is just about facts and current state.
+
+| Features                                                               | pinia-orm@v1.4.0                                           | @vuex-orm/core@0.36.4                                             | @vuex-orm/core@1.0.0-draft.16                                             |
+|------------------------------------------------------------------------|------------------------------------------------------------| ----------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| Bundle Size (Min + GZIP)                                               | [9.9 KB](https://bundlephobia.com/package/pinia-orm@1.4.0) | [16.7 KB](https://bundlephobia.com/package/@vuex-orm/core@0.36.4) | [12.6 KB](https://bundlephobia.com/package/@vuex-orm/core@1.0.0-draft.16) |
+| Relations (hasMany, belongsTo, morphOne, hasManyBy, hasOne, morphTo)   | ✅                                                          | ✅                                                                | ✅                                                                        |
+| Relations (morphMany, belongsToMany, hasManyThrough)                   | ✅                                                          | ✅                                                                | ❌                                                                        |
+| Relations (morphToMany, morphedByMany)                                 | ❌                                                          | ✅                                                                | ❌                                                                        |
+| Mutators                                                               | ✅                                                          | ✅                                                                | ❌                                                                        |
+| Casts                                                                  | ✅                                                          | ❌                                                                | ❌                                                                        |
+| Decorators                                                             | ✅                                                          | ❌                                                                | ✅                                                                        |
+| Single Table Inheritance                                               | ✅                                                          | ✅                                                                | ❌                                                                        |
+| Lifecycle Hooks                                                        | ✅                                                          | ✅                                                                | ❌                                                                        |
+| Aggregates                                                             | ✅                                                          | ✅                                                                | ❌                                                                        |
+| Query (orHas, doesntHave, orDoesntHave, whereHas, orWhereHas, groupBy) | ✅                                                          | ❌                                                                | ❌                                                                        |
+| Collection Helpers                                                     | ✅                                                          | (✅) can use pinia-orm helpers too                                | (✅) can use pinia-orm helpers too                                        |
+| Hidden Fields                                                          | ✅                                                          | ❌                                                                | ❌                                                                        |
+| Metadata field                                                         | ✅                                                          | ❌                                                                | ❌                                                                        |
+| Caching of queries with gc                                             | ✅                                                          | (✅) with plugin                                                  | ❌                                                                        |
+
+If you decide to migrate then there are some breaking changes. A guide how to migrate will be written.
+Small overview:
+
+- Fields are by default `null`
+- Renamed some functions aligning more with laravel naming
+- Code is based on `vuex-orm-next` and not on `vuex-orm` !
+
+## Help me keep working on this project 💚
+
+- [Become a Sponsor on GitHub](https://github.com/sponsors/codedredd)
+- [One-time donation via PayPal](https://paypal.me/dredd1984)
+
+<p align="center">
+  <a href="https://pinia-orm.codedredd.de/sponsorkit/sponsors.png">
+    <img src='https://pinia-orm.codedredd.de/sponsorkit/sponsors.svg'/>
+  </a>
+</p>
+
+---
+
+## 💻 Development
+
+- Clone this repository
+- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable` (use `npm i -g corepack` for Node.js < 16.10)
+- Install dependencies using `pnpm install`
+- Build normalizr package: `pnpm build`
+- Run interactive tests using `cd packages/pinia-orm && pnpm test:ui`
+
+## Credits
+
+- [Kia King Ishii](https://github.com/kiaking)
+- [Cuebit](https://github.com/cuebit)
+- [Posva](https://github.com/posva)
+
+## Related projects
+
+- [Vuex ORM](https://github.com/vuex-orm/vuex-orm)
+- [Vuex ORM Next](https://github.com/vuex-orm/vuex-orm-next)
+
+## License
+
+Made with ❤️
+
+Published under [MIT License](./LICENCE).
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/pinia-orm/latest.svg
+[code-coverage-src]: https://img.shields.io/codecov/c/github/CodeDredd/pinia-orm?logo=Codecov&logoColor=white&token=BYLAJJOOLS
+[code-coverage-href]: https://app.codecov.io/gh/CodeDredd/pinia-orm
+[npm-version-href]: https://npmjs.com/package/pinia-orm
+[npm-downloads-src]: https://img.shields.io/npm/dm/pinia-orm.svg
+[npm-downloads-href]: https://npmjs.com/package/pinia-orm
+[github-actions-ci-src]: https://github.com/codedredd/pinia-orm/actions/workflows/ci.yml/badge.svg
+[github-actions-ci-href]: https://github.com/codedredd/pinia-orm/actions?query=workflow%3Aci
+[license-src]: https://img.shields.io/npm/l/pinia-orm.svg
+[license-href]: https://npmjs.com/package/pinia-orm

package/dist/index.cjs

@@ -0,0 +1,292 @@
+'use strict';
+
+const piniaOrm = require('pinia-orm');
+
+var __defProp$2 = Object.defineProperty;
+var __defNormalProp$2 = (obj, key, value) => key in obj ? __defProp$2(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$2 = (obj, key, value) => {
+  __defNormalProp$2(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class Response {
+  /**
+   * Create a new response instance.
+   */
+  constructor(repository, config, response) {
+    /**
+     * The repository that called the request.
+     */
+    __publicField$2(this, "repository");
+    /**
+     * The request configuration.
+     */
+    __publicField$2(this, "config");
+    /**
+     * The axios response instance.
+     */
+    __publicField$2(this, "response");
+    /**
+     * Entities created by Pinia ORM.
+     */
+    __publicField$2(this, "entities", null);
+    /**
+     * Whether if response data is saved to the store or not.
+     */
+    __publicField$2(this, "isSaved", false);
+    this.repository = repository;
+    this.config = config;
+    this.response = response;
+  }
+  /**
+   * Save response data to the store.
+   */
+  async save() {
+    const data = this.getDataFromResponse();
+    if (!this.validateData(data)) {
+      console.warn(
+        "[Pinia ORM Axios] The response data could not be saved to the store because it is not an object or an array. You might want to use `dataTransformer` option to handle non-array/object response before saving it to the store."
+      );
+      return;
+    }
+    let method = this.config.persistBy || "save";
+    if (!this.validatePersistAction(method)) {
+      console.warn(
+        '[Pinia ORM Axios] The "persistBy" option configured is not a recognized value. Response data will be persisted by the default `save` method.'
+      );
+      method = "save";
+    }
+    const result = await this.repository[method](data);
+    this.entities = Array.isArray(result) ? result : [result];
+    this.isSaved = true;
+  }
+  /**
+   * Delete the entity record where the `delete` option is configured.
+   */
+  async delete() {
+    if (this.config.delete === void 0) {
+      throw new Error(
+        "[Pinia ORM Axios] Could not delete records because the `delete` option is not set."
+      );
+    }
+    await this.repository.query().destroy(this.config.delete);
+  }
+  /**
+   * Get the response data from the axios response object. If a `dataTransformer`
+   * option is configured, it will be applied to the response object. If the
+   * `dataKey` option is configured, it will return the data from the given
+   * property within the response body.
+   */
+  getDataFromResponse() {
+    if (this.config.dataTransformer) {
+      return this.config.dataTransformer(this.response);
+    }
+    if (this.config.dataKey) {
+      return this.response.data[this.config.dataKey];
+    }
+    return this.response.data;
+  }
+  /**
+   * Get persist options if any set in config.
+   */
+  // protected getPersistOptions (): PersistOptions | undefined {
+  //   const persistOptions = this.config.persistOptions
+  //
+  //   if (!persistOptions || typeof persistOptions !== 'object') {
+  //     return
+  //   }
+  //
+  //   return Object.keys(persistOptions)
+  //     .filter(this.validatePersistAction) // Filter to avoid polluting the payload.
+  //     .reduce((carry, key) => {
+  //       carry[key] = persistOptions[key]
+  //       return carry
+  //     }, {} as PersistOptions)
+  // }
+  /**
+   * Validate the given data to ensure the Pinia ORM persist methods accept it.
+   */
+  validateData(data) {
+    return data !== null && typeof data === "object";
+  }
+  /**
+   * Validate the given string as to ensure it correlates with the available
+   * Pinia ORM persist methods.
+   */
+  validatePersistAction(action) {
+    return ["save", "insert"].includes(action);
+  }
+}
+
+var __defProp$1 = Object.defineProperty;
+var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$1 = (obj, key, value) => {
+  __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class Request {
+  /**
+   * Create a new api instance.
+   */
+  constructor(repository) {
+    /**
+     * The repository class.
+     */
+    __publicField$1(this, "repository");
+    /**
+     * The default config.
+     */
+    __publicField$1(this, "config", {
+      save: true
+    });
+    this.repository = repository;
+    this.registerActions();
+  }
+  /**
+   * Get the axios client.
+   */
+  get axios() {
+    if (!this.repository.axios) {
+      throw new Error(
+        "[Pinia ORM Axios] The axios instance is not registered. Please register the axios instance to the repository."
+      );
+    }
+    return this.repository.axios;
+  }
+  /**
+   * Register actions from the repository config.
+   */
+  registerActions() {
+    const actions = { ...this.repository.config.axiosApi?.actions, ...this.repository.getModel().$config()?.axiosApi?.actions };
+    if (!actions) {
+      return;
+    }
+    for (const name in actions) {
+      const action = actions[name];
+      typeof action === "function" ? this.registerFunctionAction(name, action) : this.registerObjectAction(name, action);
+    }
+  }
+  /**
+   * Register the given object action.
+   */
+  registerObjectAction(name, action) {
+    this[name] = (config) => {
+      return this.request({ ...action, ...config });
+    };
+  }
+  /**
+   * Register the given function action.
+   */
+  registerFunctionAction(name, action) {
+    this[name] = action.bind(this);
+  }
+  /**
+   * Perform a get request.
+   */
+  get(url, config = {}) {
+    return this.request({ method: "get", url, ...config });
+  }
+  /**
+   * Perform a post request.
+   */
+  post(url, data = {}, config = {}) {
+    return this.request({ method: "post", url, data, ...config });
+  }
+  /**
+   * Perform a put request.
+   */
+  put(url, data = {}, config = {}) {
+    return this.request({ method: "put", url, data, ...config });
+  }
+  /**
+   * Perform a patch request.
+   */
+  patch(url, data = {}, config = {}) {
+    return this.request({ method: "patch", url, data, ...config });
+  }
+  /**
+   * Perform a delete request.
+   */
+  delete(url, config = {}) {
+    return this.request({ method: "delete", url, ...config });
+  }
+  /**
+   * Perform an api request.
+   */
+  async request(config) {
+    const requestConfig = this.createConfig(config);
+    const axiosResponse = await this.axios.request(requestConfig);
+    return this.createResponse(axiosResponse, requestConfig);
+  }
+  /**
+   * Create a new config by merging the global config, the repository config,
+   * and the given config.
+   */
+  createConfig(config) {
+    return {
+      ...this.config,
+      ...this.repository.globalApiConfig,
+      ...this.repository.apiConfig,
+      ...config
+    };
+  }
+  /**
+   * Create a new response instance by applying a few initialization processes.
+   * For example, it saves response data if `save` option id set to `true`.
+   */
+  async createResponse(axiosResponse, config) {
+    const response = new Response(this.repository, config, axiosResponse);
+    if (config.delete !== void 0) {
+      await response.delete();
+      return response;
+    }
+    config.save && await response.save();
+    return response;
+  }
+}
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class AxiosRepository extends piniaOrm.Repository {
+  constructor() {
+    super(...arguments);
+    __publicField(this, "axios", piniaOrm.config?.axiosApi?.axios || null);
+    __publicField(this, "globalApiConfig", piniaOrm.config?.axiosApi || {});
+    __publicField(this, "apiConfig", {});
+  }
+  api() {
+    return useAxiosApi(this);
+  }
+  setAxios(axios) {
+    this.axios = axios;
+    return this;
+  }
+}
+
+function useAxiosApi(repository) {
+  return new Request(repository);
+}
+
+function useAxiosRepo(model) {
+  AxiosRepository.useModel = model;
+  return piniaOrm.useRepo(AxiosRepository);
+}
+
+function createPiniaOrmAxios(axiosConfig) {
+  return piniaOrm.definePiniaOrmPlugin((context) => {
+    context.config.axiosApi = axiosConfig;
+    return context;
+  });
+}
+const piniaOrmPluginAxios = createPiniaOrmAxios();
+
+exports.AxiosRepository = AxiosRepository;
+exports.Request = Request;
+exports.Response = Response;
+exports.createPiniaOrmAxios = createPiniaOrmAxios;
+exports.piniaOrmPluginAxios = piniaOrmPluginAxios;
+exports.useAxiosApi = useAxiosApi;
+exports.useAxiosRepo = useAxiosRepo;

package/dist/index.d.cts

@@ -0,0 +1,164 @@
+import { AxiosRequestConfig, AxiosResponse, AxiosInstance } from 'axios';
+import { Element, Model, Repository, Collection, PiniaOrmPlugin } from 'pinia-orm';
+
+type PersistMethods = 'save' | 'insert';
+type PersistOptions = {
+    [P in PersistMethods]?: string[];
+};
+interface Config extends AxiosRequestConfig {
+    dataKey?: string;
+    url?: string;
+    method?: string;
+    data?: any;
+    dataTransformer?: (response: AxiosResponse) => Element | Element[];
+    save?: boolean;
+    persistBy?: PersistMethods;
+    persistOptions?: PersistOptions;
+    delete?: string | number | ((model: Model) => boolean);
+    actions?: {
+        [name: string]: any;
+    };
+}
+interface GlobalConfig extends Config {
+    axios?: AxiosInstance;
+}
+
+declare class AxiosRepository<M extends Model = Model> extends Repository<M> {
+    axios: AxiosInstance;
+    globalApiConfig: any;
+    apiConfig: Config;
+    api(): Request;
+    setAxios(axios: AxiosInstance): this;
+}
+
+declare class Response {
+    /**
+     * The repository that called the request.
+     */
+    repository: AxiosRepository;
+    /**
+     * The request configuration.
+     */
+    config: Config;
+    /**
+     * The axios response instance.
+     */
+    response: AxiosResponse;
+    /**
+     * Entities created by Pinia ORM.
+     */
+    entities: Collection | null;
+    /**
+     * Whether if response data is saved to the store or not.
+     */
+    isSaved: boolean;
+    /**
+     * Create a new response instance.
+     */
+    constructor(repository: AxiosRepository, config: Config, response: AxiosResponse);
+    /**
+     * Save response data to the store.
+     */
+    save(): Promise<void>;
+    /**
+     * Delete the entity record where the `delete` option is configured.
+     */
+    delete(): Promise<void>;
+    /**
+     * Get the response data from the axios response object. If a `dataTransformer`
+     * option is configured, it will be applied to the response object. If the
+     * `dataKey` option is configured, it will return the data from the given
+     * property within the response body.
+     */
+    getDataFromResponse(): Element | Element[];
+    /**
+     * Get persist options if any set in config.
+     */
+    /**
+     * Validate the given data to ensure the Pinia ORM persist methods accept it.
+     */
+    protected validateData(data: any): data is Element | Element[];
+    /**
+     * Validate the given string as to ensure it correlates with the available
+     * Pinia ORM persist methods.
+     */
+    protected validatePersistAction(action: string): action is PersistMethods;
+}
+
+declare class Request {
+    /**
+     * The repository class.
+     */
+    repository: AxiosRepository;
+    /**
+     * The default config.
+     */
+    config: Config;
+    /**
+     * Create a new api instance.
+     */
+    constructor(repository: AxiosRepository);
+    /**
+     * Index key for the user defined actions.
+     */
+    [action: string]: any;
+    /**
+     * Get the axios client.
+     */
+    get axios(): AxiosInstance;
+    /**
+     * Register actions from the repository config.
+     */
+    private registerActions;
+    /**
+     * Register the given object action.
+     */
+    private registerObjectAction;
+    /**
+     * Register the given function action.
+     */
+    private registerFunctionAction;
+    /**
+     * Perform a get request.
+     */
+    get(url: string, config?: Config): Promise<Response>;
+    /**
+     * Perform a post request.
+     */
+    post(url: string, data?: any, config?: Config): Promise<Response>;
+    /**
+     * Perform a put request.
+     */
+    put(url: string, data?: any, config?: Config): Promise<Response>;
+    /**
+     * Perform a patch request.
+     */
+    patch(url: string, data?: any, config?: Config): Promise<Response>;
+    /**
+     * Perform a delete request.
+     */
+    delete(url: string, config?: Config): Promise<Response>;
+    /**
+     * Perform an api request.
+     */
+    request(config: Config): Promise<Response>;
+    /**
+     * Create a new config by merging the global config, the repository config,
+     * and the given config.
+     */
+    private createConfig;
+    /**
+     * Create a new response instance by applying a few initialization processes.
+     * For example, it saves response data if `save` option id set to `true`.
+     */
+    private createResponse;
+}
+
+declare function useAxiosApi(repository: AxiosRepository): Request;
+
+declare function useAxiosRepo<M extends Model>(model: M): AxiosRepository<Model>;
+
+declare function createPiniaOrmAxios(axiosConfig?: GlobalConfig): PiniaOrmPlugin;
+declare const piniaOrmPluginAxios: PiniaOrmPlugin;
+
+export { AxiosRepository, Request, Response, createPiniaOrmAxios, piniaOrmPluginAxios, useAxiosApi, useAxiosRepo };

package/dist/index.d.mts

@@ -0,0 +1,164 @@
+import { AxiosRequestConfig, AxiosResponse, AxiosInstance } from 'axios';
+import { Element, Model, Repository, Collection, PiniaOrmPlugin } from 'pinia-orm';
+
+type PersistMethods = 'save' | 'insert';
+type PersistOptions = {
+    [P in PersistMethods]?: string[];
+};
+interface Config extends AxiosRequestConfig {
+    dataKey?: string;
+    url?: string;
+    method?: string;
+    data?: any;
+    dataTransformer?: (response: AxiosResponse) => Element | Element[];
+    save?: boolean;
+    persistBy?: PersistMethods;
+    persistOptions?: PersistOptions;
+    delete?: string | number | ((model: Model) => boolean);
+    actions?: {
+        [name: string]: any;
+    };
+}
+interface GlobalConfig extends Config {
+    axios?: AxiosInstance;
+}
+
+declare class AxiosRepository<M extends Model = Model> extends Repository<M> {
+    axios: AxiosInstance;
+    globalApiConfig: any;
+    apiConfig: Config;
+    api(): Request;
+    setAxios(axios: AxiosInstance): this;
+}
+
+declare class Response {
+    /**
+     * The repository that called the request.
+     */
+    repository: AxiosRepository;
+    /**
+     * The request configuration.
+     */
+    config: Config;
+    /**
+     * The axios response instance.
+     */
+    response: AxiosResponse;
+    /**
+     * Entities created by Pinia ORM.
+     */
+    entities: Collection | null;
+    /**
+     * Whether if response data is saved to the store or not.
+     */
+    isSaved: boolean;
+    /**
+     * Create a new response instance.
+     */
+    constructor(repository: AxiosRepository, config: Config, response: AxiosResponse);
+    /**
+     * Save response data to the store.
+     */
+    save(): Promise<void>;
+    /**
+     * Delete the entity record where the `delete` option is configured.
+     */
+    delete(): Promise<void>;
+    /**
+     * Get the response data from the axios response object. If a `dataTransformer`
+     * option is configured, it will be applied to the response object. If the
+     * `dataKey` option is configured, it will return the data from the given
+     * property within the response body.
+     */
+    getDataFromResponse(): Element | Element[];
+    /**
+     * Get persist options if any set in config.
+     */
+    /**
+     * Validate the given data to ensure the Pinia ORM persist methods accept it.
+     */
+    protected validateData(data: any): data is Element | Element[];
+    /**
+     * Validate the given string as to ensure it correlates with the available
+     * Pinia ORM persist methods.
+     */
+    protected validatePersistAction(action: string): action is PersistMethods;
+}
+
+declare class Request {
+    /**
+     * The repository class.
+     */
+    repository: AxiosRepository;
+    /**
+     * The default config.
+     */
+    config: Config;
+    /**
+     * Create a new api instance.
+     */
+    constructor(repository: AxiosRepository);
+    /**
+     * Index key for the user defined actions.
+     */
+    [action: string]: any;
+    /**
+     * Get the axios client.
+     */
+    get axios(): AxiosInstance;
+    /**
+     * Register actions from the repository config.
+     */
+    private registerActions;
+    /**
+     * Register the given object action.
+     */
+    private registerObjectAction;
+    /**
+     * Register the given function action.
+     */
+    private registerFunctionAction;
+    /**
+     * Perform a get request.
+     */
+    get(url: string, config?: Config): Promise<Response>;
+    /**
+     * Perform a post request.
+     */
+    post(url: string, data?: any, config?: Config): Promise<Response>;
+    /**
+     * Perform a put request.
+     */
+    put(url: string, data?: any, config?: Config): Promise<Response>;
+    /**
+     * Perform a patch request.
+     */
+    patch(url: string, data?: any, config?: Config): Promise<Response>;
+    /**
+     * Perform a delete request.
+     */
+    delete(url: string, config?: Config): Promise<Response>;
+    /**
+     * Perform an api request.
+     */
+    request(config: Config): Promise<Response>;
+    /**
+     * Create a new config by merging the global config, the repository config,
+     * and the given config.
+     */
+    private createConfig;
+    /**
+     * Create a new response instance by applying a few initialization processes.
+     * For example, it saves response data if `save` option id set to `true`.
+     */
+    private createResponse;
+}
+
+declare function useAxiosApi(repository: AxiosRepository): Request;
+
+declare function useAxiosRepo<M extends Model>(model: M): AxiosRepository<Model>;
+
+declare function createPiniaOrmAxios(axiosConfig?: GlobalConfig): PiniaOrmPlugin;
+declare const piniaOrmPluginAxios: PiniaOrmPlugin;
+
+export { AxiosRepository, Request, Response, createPiniaOrmAxios, piniaOrmPluginAxios, useAxiosApi, useAxiosRepo };

package/dist/index.d.ts

@@ -0,0 +1,164 @@
+import { AxiosRequestConfig, AxiosResponse, AxiosInstance } from 'axios';
+import { Element, Model, Repository, Collection, PiniaOrmPlugin } from 'pinia-orm';
+
+type PersistMethods = 'save' | 'insert';
+type PersistOptions = {
+    [P in PersistMethods]?: string[];
+};
+interface Config extends AxiosRequestConfig {
+    dataKey?: string;
+    url?: string;
+    method?: string;
+    data?: any;
+    dataTransformer?: (response: AxiosResponse) => Element | Element[];
+    save?: boolean;
+    persistBy?: PersistMethods;
+    persistOptions?: PersistOptions;
+    delete?: string | number | ((model: Model) => boolean);
+    actions?: {
+        [name: string]: any;
+    };
+}
+interface GlobalConfig extends Config {
+    axios?: AxiosInstance;
+}
+
+declare class AxiosRepository<M extends Model = Model> extends Repository<M> {
+    axios: AxiosInstance;
+    globalApiConfig: any;
+    apiConfig: Config;
+    api(): Request;
+    setAxios(axios: AxiosInstance): this;
+}
+
+declare class Response {
+    /**
+     * The repository that called the request.
+     */
+    repository: AxiosRepository;
+    /**
+     * The request configuration.
+     */
+    config: Config;
+    /**
+     * The axios response instance.
+     */
+    response: AxiosResponse;
+    /**
+     * Entities created by Pinia ORM.
+     */
+    entities: Collection | null;
+    /**
+     * Whether if response data is saved to the store or not.
+     */
+    isSaved: boolean;
+    /**
+     * Create a new response instance.
+     */
+    constructor(repository: AxiosRepository, config: Config, response: AxiosResponse);
+    /**
+     * Save response data to the store.
+     */
+    save(): Promise<void>;
+    /**
+     * Delete the entity record where the `delete` option is configured.
+     */
+    delete(): Promise<void>;
+    /**
+     * Get the response data from the axios response object. If a `dataTransformer`
+     * option is configured, it will be applied to the response object. If the
+     * `dataKey` option is configured, it will return the data from the given
+     * property within the response body.
+     */
+    getDataFromResponse(): Element | Element[];
+    /**
+     * Get persist options if any set in config.
+     */
+    /**
+     * Validate the given data to ensure the Pinia ORM persist methods accept it.
+     */
+    protected validateData(data: any): data is Element | Element[];
+    /**
+     * Validate the given string as to ensure it correlates with the available
+     * Pinia ORM persist methods.
+     */
+    protected validatePersistAction(action: string): action is PersistMethods;
+}
+
+declare class Request {
+    /**
+     * The repository class.
+     */
+    repository: AxiosRepository;
+    /**
+     * The default config.
+     */
+    config: Config;
+    /**
+     * Create a new api instance.
+     */
+    constructor(repository: AxiosRepository);
+    /**
+     * Index key for the user defined actions.
+     */
+    [action: string]: any;
+    /**
+     * Get the axios client.
+     */
+    get axios(): AxiosInstance;
+    /**
+     * Register actions from the repository config.
+     */
+    private registerActions;
+    /**
+     * Register the given object action.
+     */
+    private registerObjectAction;
+    /**
+     * Register the given function action.
+     */
+    private registerFunctionAction;
+    /**
+     * Perform a get request.
+     */
+    get(url: string, config?: Config): Promise<Response>;
+    /**
+     * Perform a post request.
+     */
+    post(url: string, data?: any, config?: Config): Promise<Response>;
+    /**
+     * Perform a put request.
+     */
+    put(url: string, data?: any, config?: Config): Promise<Response>;
+    /**
+     * Perform a patch request.
+     */
+    patch(url: string, data?: any, config?: Config): Promise<Response>;
+    /**
+     * Perform a delete request.
+     */
+    delete(url: string, config?: Config): Promise<Response>;
+    /**
+     * Perform an api request.
+     */
+    request(config: Config): Promise<Response>;
+    /**
+     * Create a new config by merging the global config, the repository config,
+     * and the given config.
+     */
+    private createConfig;
+    /**
+     * Create a new response instance by applying a few initialization processes.
+     * For example, it saves response data if `save` option id set to `true`.
+     */
+    private createResponse;
+}
+
+declare function useAxiosApi(repository: AxiosRepository): Request;
+
+declare function useAxiosRepo<M extends Model>(model: M): AxiosRepository<Model>;
+
+declare function createPiniaOrmAxios(axiosConfig?: GlobalConfig): PiniaOrmPlugin;
+declare const piniaOrmPluginAxios: PiniaOrmPlugin;
+
+export { AxiosRepository, Request, Response, createPiniaOrmAxios, piniaOrmPluginAxios, useAxiosApi, useAxiosRepo };

package/dist/index.mjs

@@ -0,0 +1,284 @@
+import { Repository, config, useRepo, definePiniaOrmPlugin } from 'pinia-orm';
+
+var __defProp$2 = Object.defineProperty;
+var __defNormalProp$2 = (obj, key, value) => key in obj ? __defProp$2(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$2 = (obj, key, value) => {
+  __defNormalProp$2(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class Response {
+  /**
+   * Create a new response instance.
+   */
+  constructor(repository, config, response) {
+    /**
+     * The repository that called the request.
+     */
+    __publicField$2(this, "repository");
+    /**
+     * The request configuration.
+     */
+    __publicField$2(this, "config");
+    /**
+     * The axios response instance.
+     */
+    __publicField$2(this, "response");
+    /**
+     * Entities created by Pinia ORM.
+     */
+    __publicField$2(this, "entities", null);
+    /**
+     * Whether if response data is saved to the store or not.
+     */
+    __publicField$2(this, "isSaved", false);
+    this.repository = repository;
+    this.config = config;
+    this.response = response;
+  }
+  /**
+   * Save response data to the store.
+   */
+  async save() {
+    const data = this.getDataFromResponse();
+    if (!this.validateData(data)) {
+      console.warn(
+        "[Pinia ORM Axios] The response data could not be saved to the store because it is not an object or an array. You might want to use `dataTransformer` option to handle non-array/object response before saving it to the store."
+      );
+      return;
+    }
+    let method = this.config.persistBy || "save";
+    if (!this.validatePersistAction(method)) {
+      console.warn(
+        '[Pinia ORM Axios] The "persistBy" option configured is not a recognized value. Response data will be persisted by the default `save` method.'
+      );
+      method = "save";
+    }
+    const result = await this.repository[method](data);
+    this.entities = Array.isArray(result) ? result : [result];
+    this.isSaved = true;
+  }
+  /**
+   * Delete the entity record where the `delete` option is configured.
+   */
+  async delete() {
+    if (this.config.delete === void 0) {
+      throw new Error(
+        "[Pinia ORM Axios] Could not delete records because the `delete` option is not set."
+      );
+    }
+    await this.repository.query().destroy(this.config.delete);
+  }
+  /**
+   * Get the response data from the axios response object. If a `dataTransformer`
+   * option is configured, it will be applied to the response object. If the
+   * `dataKey` option is configured, it will return the data from the given
+   * property within the response body.
+   */
+  getDataFromResponse() {
+    if (this.config.dataTransformer) {
+      return this.config.dataTransformer(this.response);
+    }
+    if (this.config.dataKey) {
+      return this.response.data[this.config.dataKey];
+    }
+    return this.response.data;
+  }
+  /**
+   * Get persist options if any set in config.
+   */
+  // protected getPersistOptions (): PersistOptions | undefined {
+  //   const persistOptions = this.config.persistOptions
+  //
+  //   if (!persistOptions || typeof persistOptions !== 'object') {
+  //     return
+  //   }
+  //
+  //   return Object.keys(persistOptions)
+  //     .filter(this.validatePersistAction) // Filter to avoid polluting the payload.
+  //     .reduce((carry, key) => {
+  //       carry[key] = persistOptions[key]
+  //       return carry
+  //     }, {} as PersistOptions)
+  // }
+  /**
+   * Validate the given data to ensure the Pinia ORM persist methods accept it.
+   */
+  validateData(data) {
+    return data !== null && typeof data === "object";
+  }
+  /**
+   * Validate the given string as to ensure it correlates with the available
+   * Pinia ORM persist methods.
+   */
+  validatePersistAction(action) {
+    return ["save", "insert"].includes(action);
+  }
+}
+
+var __defProp$1 = Object.defineProperty;
+var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$1 = (obj, key, value) => {
+  __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class Request {
+  /**
+   * Create a new api instance.
+   */
+  constructor(repository) {
+    /**
+     * The repository class.
+     */
+    __publicField$1(this, "repository");
+    /**
+     * The default config.
+     */
+    __publicField$1(this, "config", {
+      save: true
+    });
+    this.repository = repository;
+    this.registerActions();
+  }
+  /**
+   * Get the axios client.
+   */
+  get axios() {
+    if (!this.repository.axios) {
+      throw new Error(
+        "[Pinia ORM Axios] The axios instance is not registered. Please register the axios instance to the repository."
+      );
+    }
+    return this.repository.axios;
+  }
+  /**
+   * Register actions from the repository config.
+   */
+  registerActions() {
+    const actions = { ...this.repository.config.axiosApi?.actions, ...this.repository.getModel().$config()?.axiosApi?.actions };
+    if (!actions) {
+      return;
+    }
+    for (const name in actions) {
+      const action = actions[name];
+      typeof action === "function" ? this.registerFunctionAction(name, action) : this.registerObjectAction(name, action);
+    }
+  }
+  /**
+   * Register the given object action.
+   */
+  registerObjectAction(name, action) {
+    this[name] = (config) => {
+      return this.request({ ...action, ...config });
+    };
+  }
+  /**
+   * Register the given function action.
+   */
+  registerFunctionAction(name, action) {
+    this[name] = action.bind(this);
+  }
+  /**
+   * Perform a get request.
+   */
+  get(url, config = {}) {
+    return this.request({ method: "get", url, ...config });
+  }
+  /**
+   * Perform a post request.
+   */
+  post(url, data = {}, config = {}) {
+    return this.request({ method: "post", url, data, ...config });
+  }
+  /**
+   * Perform a put request.
+   */
+  put(url, data = {}, config = {}) {
+    return this.request({ method: "put", url, data, ...config });
+  }
+  /**
+   * Perform a patch request.
+   */
+  patch(url, data = {}, config = {}) {
+    return this.request({ method: "patch", url, data, ...config });
+  }
+  /**
+   * Perform a delete request.
+   */
+  delete(url, config = {}) {
+    return this.request({ method: "delete", url, ...config });
+  }
+  /**
+   * Perform an api request.
+   */
+  async request(config) {
+    const requestConfig = this.createConfig(config);
+    const axiosResponse = await this.axios.request(requestConfig);
+    return this.createResponse(axiosResponse, requestConfig);
+  }
+  /**
+   * Create a new config by merging the global config, the repository config,
+   * and the given config.
+   */
+  createConfig(config) {
+    return {
+      ...this.config,
+      ...this.repository.globalApiConfig,
+      ...this.repository.apiConfig,
+      ...config
+    };
+  }
+  /**
+   * Create a new response instance by applying a few initialization processes.
+   * For example, it saves response data if `save` option id set to `true`.
+   */
+  async createResponse(axiosResponse, config) {
+    const response = new Response(this.repository, config, axiosResponse);
+    if (config.delete !== void 0) {
+      await response.delete();
+      return response;
+    }
+    config.save && await response.save();
+    return response;
+  }
+}
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class AxiosRepository extends Repository {
+  constructor() {
+    super(...arguments);
+    __publicField(this, "axios", config?.axiosApi?.axios || null);
+    __publicField(this, "globalApiConfig", config?.axiosApi || {});
+    __publicField(this, "apiConfig", {});
+  }
+  api() {
+    return useAxiosApi(this);
+  }
+  setAxios(axios) {
+    this.axios = axios;
+    return this;
+  }
+}
+
+function useAxiosApi(repository) {
+  return new Request(repository);
+}
+
+function useAxiosRepo(model) {
+  AxiosRepository.useModel = model;
+  return useRepo(AxiosRepository);
+}
+
+function createPiniaOrmAxios(axiosConfig) {
+  return definePiniaOrmPlugin((context) => {
+    context.config.axiosApi = axiosConfig;
+    return context;
+  });
+}
+const piniaOrmPluginAxios = createPiniaOrmAxios();
+
+export { AxiosRepository, Request, Response, createPiniaOrmAxios, piniaOrmPluginAxios, useAxiosApi, useAxiosRepo };

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@pinia-orm/axios-edge",
+  "version": "1.7.1-28257628.bbb8bab",
+  "description": "Axios plugin for pinia-orm",
+  "bugs": {
+    "url": "https://github.com/CodeDredd/pinia-orm/issues"
+  },
+  "homepage": "https://github.com/CodeDredd/pinia-orm",
+  "repository": {
+    "url": "https://github.com/CodeDredd/pinia-orm.git",
+    "type": "git"
+  },
+  "keywords": [
+    "axios",
+    "pinia-orm",
+    "api"
+  ],
+  "files": [
+    "dist/",
+    "index.d.ts",
+    "LICENSE",
+    "README.md"
+  ],
+  "type": "module",
+  "funding": "https://github.com/sponsors/codedredd",
+  "jsdelivr": "dist/index.mjs",
+  "unpkg": "dist/index.mjs",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.mjs"
+    },
+    "./*": "./*"
+  },
+  "sideEffects": false,
+  "author": {
+    "name": "Gregor Becker",
+    "email": "gregor@codedredd.de"
+  },
+  "license": "MIT",
+  "peerDependencies": {
+    "pinia-orm": "npm:pinia-orm-edge@1.7.3-28257628.bbb8bab",
+    "axios": ">=1.5.0"
+  },
+  "devDependencies": {
+    "@nuxtjs/eslint-config-typescript": "^12.1.0",
+    "@size-limit/preset-small-lib": "^9.0.0",
+    "@vitest/coverage-v8": "^0.34.5",
+    "axios": "^1.5.0",
+    "axios-mock-adapter": "^1.22.0",
+    "eslint": "^8.49.0",
+    "pinia-orm": "npm:pinia-orm-edge@1.7.3-28257628.bbb8bab",
+    "pinia": "^2.1.6",
+    "size-limit": "^9.0.0",
+    "typescript": "^5.2.2",
+    "unbuild": "^2.0.0",
+    "vitest": "^0.34.5",
+    "vue-demi": "^0.14.6"
+  },
+  "size-limit": [
+    {
+      "path": "dist/index.mjs",
+      "limit": "2 kB"
+    }
+  ],
+  "_name": "@pinia-orm/axios",
+  "scripts": {
+    "build": "unbuild",
+    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s --commit-path . -l @pinia-orm/axios -r 1",
+    "size": "size-limit",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --fix --ext .ts",
+    "test:ui": "vue-demi-switch 3 && vitest --ui --api 9527",
+    "test:watch": "vue-demi-switch 3 && vitest --watch",
+    "test:2": "vue-demi-switch 2 vue2 && vitest --run",
+    "test:3": "vue-demi-switch 3 && vitest --run",
+    "test": "pnpm run test:3"
+  }
+}