@litepos/autoquery 5.0.1

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-PRESENT Anthony Fu <https://github.com/antfu>
+
+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,42 @@
+# pkg-placeholder
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![bundle][bundle-src]][bundle-href]
+[![JSDocs][jsdocs-src]][jsdocs-href]
+[![License][license-src]][license-href]
+
+_description_
+
+## Note for Developers
+
+This starter recommands using [npm Trusted Publisher](https://github.com/e18e/ecosystem-issues/issues/201), where the release is done on CI to ensure the security of the packages.
+
+To do so, you need to run `pnpm publish` manually for the very first time to create the package on npm, and then go to `https://www.npmjs.com/package/<your-package-name>/access` to set the connection to your GitHub repo.
+
+Then for the future releases, you can run `pnpm run release` to do the release and the GitHub Actions will take care of the release process.
+
+## Sponsors
+
+<p align="center">
+  <a href="https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg">
+    <img src='https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg'/>
+  </a>
+</p>
+
+## License
+
+[MIT](./LICENSE) License © [Anthony Fu](https://github.com/antfu)
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/pkg-placeholder?style=flat&colorA=080f12&colorB=1fa669
+[npm-version-href]: https://npmjs.com/package/pkg-placeholder
+[npm-downloads-src]: https://img.shields.io/npm/dm/pkg-placeholder?style=flat&colorA=080f12&colorB=1fa669
+[npm-downloads-href]: https://npmjs.com/package/pkg-placeholder
+[bundle-src]: https://img.shields.io/bundlephobia/minzip/pkg-placeholder?style=flat&colorA=080f12&colorB=1fa669&label=minzip
+[bundle-href]: https://bundlephobia.com/result?p=pkg-placeholder
+[license-src]: https://img.shields.io/github/license/antfu/pkg-placeholder.svg?style=flat&colorA=080f12&colorB=1fa669
+[license-href]: https://github.com/antfu/pkg-placeholder/blob/main/LICENSE
+[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669
+[jsdocs-href]: https://www.jsdocs.io/package/pkg-placeholder

package/dist/index.d.ts

@@ -0,0 +1,164 @@
+//#region src/index.d.ts
+/**
+ * The IBaseParams interface provides a structure for query parameters commonly used
+ * in API requests to manipulate the presentation and organization of returned data.
+ *
+ * @property {string} [skip] - The number of records to skip before starting to collect the response set.
+ * @property {string} [take] - The limit on the number of records to return in the response set.
+ * @property {string} [format] - The desired format of the response (e.g., 'json', 'xml').
+ * @property {string} [include] - A way to include data from related tables/entities.
+ * @property {string} [jsconfig] - JavaScript configuration for client-side handling of the response.
+ * @property {string} [orderBy] - A parameter to specify the field to order the results by in ascending order.
+ * @property {string} [orderByDesc] - A parameter to specify the field to order the results by in descending order.
+ */
+interface IBaseParams {
+  skip?: number;
+  take?: number;
+  format?: string;
+  include?: string;
+  jsconfig?: string;
+  orderBy?: string;
+  orderByDesc?: string;
+}
+interface IInvoiceParams extends IBaseParams {
+  RefIdContains?: string;
+  GrandTotal?: number;
+  StatusContains?: string;
+  PaidAtAfter?: string;
+  PaidAtBefore?: string;
+  PaidAtStartsWith?: string;
+}
+interface IInvoicesQuery {
+  params: IInvoiceParams;
+}
+declare class InvoicesQuery implements IInvoicesQuery {
+  params: {
+    format: string;
+    Include: string;
+    jsconfig: string;
+  };
+  constructor(params: IInvoiceParams);
+}
+interface IQueryResponse<T> {
+  offset?: number;
+  total?: number;
+  results?: T[];
+  meta?: {
+    [index: string]: string;
+  };
+  responseStatus?: ResponseStatus;
+}
+interface ResponseStatus {
+  errorCode?: string;
+  message?: string;
+  stackTrace?: string;
+  errors?: ValidationError[];
+}
+interface ValidationError {
+  errorCode?: string;
+  fieldName?: string;
+  message?: string;
+}
+declare class QueryResponse<T> {
+  offset?: number;
+  total?: number;
+  results?: T[];
+  meta?: {
+    [index: string]: string;
+  };
+  responseStatus?: ResponseStatus;
+}
+declare enum SortOrder {
+  Asc = "asc",
+  Desc = "desc",
+}
+type EnumToString<T> = T extends string ? string : T;
+type QueryableType<T> = { [K in keyof T]: T[K] extends Date ? Date : T[K] extends number ? number : EnumToString<T[K]> };
+type Operator<T> = T extends number ? keyof typeof NumericOperators | keyof typeof NullOperators : T extends Date ? keyof typeof DateOperators | keyof typeof NullOperators : T extends string ? keyof typeof StringOperators | keyof typeof ArrayOperators | keyof typeof NullOperators : string extends T ? keyof typeof StringOperators | keyof typeof ArrayOperators | keyof typeof NullOperators : keyof typeof NullOperators;
+type OperatorValueMap<T = any> = { [K in Operator<T>]: T extends Date ? (K extends keyof typeof DateOperators ? DateOperatorValueMap[K] : K extends keyof typeof NullOperators ? boolean : never) : T extends number ? (K extends keyof typeof NumericOperators ? number : K extends keyof typeof NullOperators ? boolean : never) : T extends string ? (K extends keyof typeof StringOperators ? string : K extends keyof typeof ArrayOperators ? string[] : K extends keyof typeof NullOperators ? boolean : never) : string extends T ? (K extends keyof typeof StringOperators ? string : K extends keyof typeof ArrayOperators ? string[] : K extends keyof typeof NullOperators ? boolean : never) : K extends keyof typeof NullOperators ? boolean : never };
+declare enum NumericOperators {
+  '>' = 0,
+  '>=' = 1,
+  '<' = 2,
+  '<=' = 3,
+  '=' = 4,
+  'GreaterThan' = 5,
+  'GreaterThanOrEqualTo' = 6,
+  'LessThan' = 7,
+  'LessThanOrEqualTo' = 8,
+  'EqualTo' = 9,
+  'NotEqualTo' = 10,
+}
+declare enum StringOperators {
+  'Contains' = 0,
+  'NotContains' = 1,
+  'StartsWith' = 2,
+  'EndsWith' = 3,
+  "Like" = 4,
+}
+declare enum ArrayOperators {
+  'In' = 0,
+  'NotIn' = 1,
+}
+declare enum NullOperators {
+  'IsNull' = 0,
+  // Check if field IS NULL
+  'IsNotNull' = 1,
+}
+declare enum MonthOperator {
+  WithinAMonth = "Contains",
+}
+declare enum DayOperator {
+  At = "StartsWith",
+}
+declare enum DateOperators {
+  'GreaterThan' = 0,
+  'GreaterThanOrEqualTo' = 1,
+  'LessThan' = 2,
+  'LessThanOrEqualTo' = 3,
+  'Between' = 4,
+  // BETWEEN value1 AND value2
+  'StartsWith' = 5,
+  // For exact date matching (e.g., "2019-01-01")
+  'Contains' = 6,
+}
+type DateOperatorValueMap = {
+  'GreaterThan': string;
+  'GreaterThanOrEqualTo': string;
+  'LessThan': string;
+  'LessThanOrEqualTo': string;
+  'Between': [string, string];
+  'StartsWith': string;
+  'Contains': MonthValues;
+};
+declare enum MonthValues {
+  Jan = "-01-",
+  Feb = "-02-",
+  Mar = "-03-",
+  Apr = "-04-",
+  May = "-05-",
+  Jun = "-06-",
+  Jul = "-07-",
+  Aug = "-08-",
+  Sep = "-09-",
+  Oct = "-10-",
+  Nov = "-11-",
+  Dec = "-12-",
+}
+declare class QueryBuilder<T> {
+  private params;
+  addParam<K extends keyof T, O extends Operator<QueryableType<T>[K]>>(property: K, operator: O, value: OperatorValueMap<QueryableType<T>[K]>[O]): this;
+  addRawParam(key: string, value: string): this;
+  includeTotal(flag: boolean): this;
+  skip(skip: number): this;
+  take(take: number): this;
+  sortBy<K extends keyof T>(property: K, orderBy: SortOrder): this;
+  jsconfig(param: string): this;
+  /** @internal */
+  _build(): Record<string, string>;
+}
+type QueryEtcParams = {
+  search_keywords?: string;
+};
+//#endregion
+export { ArrayOperators, DateOperatorValueMap, DateOperators, DayOperator, EnumToString, IBaseParams, IInvoiceParams, IInvoicesQuery, IQueryResponse, InvoicesQuery, MonthOperator, MonthValues, NullOperators, NumericOperators, Operator, OperatorValueMap, QueryBuilder, QueryEtcParams, QueryResponse, QueryableType, ResponseStatus, SortOrder, StringOperators, ValidationError };

package/dist/index.js

@@ -0,0 +1,133 @@
+//#region src/index.ts
+var InvoicesQuery = class {
+	params = {
+		format: "json",
+		Include: "total",
+		jsconfig: "dh:iso8601dt"
+	};
+	constructor(params) {
+		this.params = {
+			...this.params,
+			...params
+		};
+	}
+};
+var QueryResponse = class {
+	offset;
+	total;
+	results;
+	meta;
+	responseStatus;
+};
+let SortOrder = /* @__PURE__ */ function(SortOrder$1) {
+	SortOrder$1["Asc"] = "asc";
+	SortOrder$1["Desc"] = "desc";
+	return SortOrder$1;
+}({});
+let NumericOperators = /* @__PURE__ */ function(NumericOperators$1) {
+	NumericOperators$1[NumericOperators$1[">"] = 0] = ">";
+	NumericOperators$1[NumericOperators$1[">="] = 1] = ">=";
+	NumericOperators$1[NumericOperators$1["<"] = 2] = "<";
+	NumericOperators$1[NumericOperators$1["<="] = 3] = "<=";
+	NumericOperators$1[NumericOperators$1["="] = 4] = "=";
+	NumericOperators$1[NumericOperators$1["GreaterThan"] = 5] = "GreaterThan";
+	NumericOperators$1[NumericOperators$1["GreaterThanOrEqualTo"] = 6] = "GreaterThanOrEqualTo";
+	NumericOperators$1[NumericOperators$1["LessThan"] = 7] = "LessThan";
+	NumericOperators$1[NumericOperators$1["LessThanOrEqualTo"] = 8] = "LessThanOrEqualTo";
+	NumericOperators$1[NumericOperators$1["EqualTo"] = 9] = "EqualTo";
+	NumericOperators$1[NumericOperators$1["NotEqualTo"] = 10] = "NotEqualTo";
+	return NumericOperators$1;
+}({});
+let StringOperators = /* @__PURE__ */ function(StringOperators$1) {
+	StringOperators$1[StringOperators$1["Contains"] = 0] = "Contains";
+	StringOperators$1[StringOperators$1["NotContains"] = 1] = "NotContains";
+	StringOperators$1[StringOperators$1["StartsWith"] = 2] = "StartsWith";
+	StringOperators$1[StringOperators$1["EndsWith"] = 3] = "EndsWith";
+	StringOperators$1[StringOperators$1["Like"] = 4] = "Like";
+	return StringOperators$1;
+}({});
+let ArrayOperators = /* @__PURE__ */ function(ArrayOperators$1) {
+	ArrayOperators$1[ArrayOperators$1["In"] = 0] = "In";
+	ArrayOperators$1[ArrayOperators$1["NotIn"] = 1] = "NotIn";
+	return ArrayOperators$1;
+}({});
+let NullOperators = /* @__PURE__ */ function(NullOperators$1) {
+	NullOperators$1[NullOperators$1["IsNull"] = 0] = "IsNull";
+	NullOperators$1[NullOperators$1["IsNotNull"] = 1] = "IsNotNull";
+	return NullOperators$1;
+}({});
+let MonthOperator = /* @__PURE__ */ function(MonthOperator$1) {
+	MonthOperator$1["WithinAMonth"] = "Contains";
+	return MonthOperator$1;
+}({});
+let DayOperator = /* @__PURE__ */ function(DayOperator$1) {
+	DayOperator$1["At"] = "StartsWith";
+	return DayOperator$1;
+}({});
+let DateOperators = /* @__PURE__ */ function(DateOperators$1) {
+	DateOperators$1[DateOperators$1["GreaterThan"] = 0] = "GreaterThan";
+	DateOperators$1[DateOperators$1["GreaterThanOrEqualTo"] = 1] = "GreaterThanOrEqualTo";
+	DateOperators$1[DateOperators$1["LessThan"] = 2] = "LessThan";
+	DateOperators$1[DateOperators$1["LessThanOrEqualTo"] = 3] = "LessThanOrEqualTo";
+	DateOperators$1[DateOperators$1["Between"] = 4] = "Between";
+	DateOperators$1[DateOperators$1["StartsWith"] = 5] = "StartsWith";
+	DateOperators$1[DateOperators$1["Contains"] = 6] = "Contains";
+	return DateOperators$1;
+}({});
+let MonthValues = /* @__PURE__ */ function(MonthValues$1) {
+	MonthValues$1["Jan"] = "-01-";
+	MonthValues$1["Feb"] = "-02-";
+	MonthValues$1["Mar"] = "-03-";
+	MonthValues$1["Apr"] = "-04-";
+	MonthValues$1["May"] = "-05-";
+	MonthValues$1["Jun"] = "-06-";
+	MonthValues$1["Jul"] = "-07-";
+	MonthValues$1["Aug"] = "-08-";
+	MonthValues$1["Sep"] = "-09-";
+	MonthValues$1["Oct"] = "-10-";
+	MonthValues$1["Nov"] = "-11-";
+	MonthValues$1["Dec"] = "-12-";
+	return MonthValues$1;
+}({});
+var QueryBuilder = class {
+	params = {};
+	addParam(property, operator, value) {
+		const key = `${property.toString()}${operator}`;
+		if (operator === "IsNull" || operator === "IsNotNull") this.params[key] = "";
+		else this.params[key] = `${value}`;
+		return this;
+	}
+	addRawParam(key, value) {
+		this.params[key] = value;
+		return this;
+	}
+	includeTotal(flag) {
+		if (flag) this.params["include"] = "total";
+		return this;
+	}
+	skip(skip) {
+		this.params["skip"] = `${skip}`;
+		return this;
+	}
+	take(take) {
+		this.params["take"] = `${take}`;
+		return this;
+	}
+	sortBy(property, orderBy) {
+		if (orderBy === SortOrder.Asc) this.params["OrderBy"] = `${property.toString()}`;
+		else this.params["OrderByDesc"] = `${property.toString()}`;
+		return this;
+	}
+	jsconfig(param) {
+		this.params["jsconfig"] = param;
+		return this;
+	}
+	/** @internal */
+	_build() {
+		this.params["jsconfig"] = "dh:iso8601dt";
+		return this.params;
+	}
+};
+
+//#endregion
+export { ArrayOperators, DateOperators, DayOperator, InvoicesQuery, MonthOperator, MonthValues, NullOperators, NumericOperators, QueryBuilder, QueryResponse, SortOrder, StringOperators };

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@litepos/autoquery",
+  "type": "module",
+  "version": "5.0.1",
+  "packageManager": "pnpm@10.17.1",
+  "description": "AutoQuery is a library for building queries for LitePOS.",
+  "author": "LitePOS <info@litepos.ai>",
+  "license": "MIT",
+  "keywords": ["litepos", "autoquery", "query", "database", "sql"],
+  "sideEffects": false,
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "lint": "eslint",
+    "prepublishOnly": "nr build",
+    "release": "bumpp",
+    "start": "tsx src/index.ts",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit",
+    "prepare": "simple-git-hooks"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "catalog:cli",
+    "@antfu/ni": "catalog:cli",
+    "@antfu/utils": "catalog:inlined",
+    "@types/node": "catalog:types",
+    "bumpp": "catalog:cli",
+    "eslint": "catalog:cli",
+    "lint-staged": "catalog:cli",
+    "simple-git-hooks": "catalog:cli",
+    "tinyexec": "catalog:testing",
+    "tsdown": "catalog:cli",
+    "tsx": "catalog:cli",
+    "typescript": "catalog:cli",
+    "vite": "catalog:cli",
+    "vitest": "catalog:testing",
+    "vitest-package-exports": "catalog:testing",
+    "yaml": "catalog:testing"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "pnpm i --frozen-lockfile --ignore-scripts --offline && npx lint-staged"
+  },
+  "lint-staged": {
+    "*": "eslint --fix"
+  }
+}