@atscript/db-client 0.1.144 → 0.1.145

package/dist/index.cjs

@@ -248,13 +248,7 @@ var Client = class {
 	*/
 	async one(id, query) {
 		const controlStr = query?.controls ? (0, _uniqu_url_builder.buildUrl)({ controls: query.controls }) : "";
-		if (id !== null && typeof id === "object") {
-			const params = this._idToParams(id);
-			if (controlStr) for (const [k, v] of new URLSearchParams(controlStr)) params.set(k, v);
-			const qs = params.toString();
-			return this._getOrNull(`one${qs ? `?${qs}` : ""}`);
-		}
-		return this._getOrNull(`one/${encodeURIComponent(String(id))}${controlStr ? `?${controlStr}` : ""}`);
+		return this._getOrNull(this._idUrl("one", id, controlStr));
 	}
 	async insert(data) {
 		return this._request("POST", "", await this._prepareWrite(data, "insert"));
@@ -282,8 +276,7 @@ var Client = class {
 	* `DELETE /:id` or `DELETE /?k1=v1&k2=v2` — remove a record by primary key.
 	*/
 	async remove(id) {
-		if (id !== null && typeof id === "object") return this._request("DELETE", `?${this._idToParams(id).toString()}`);
-		return this._request("DELETE", encodeURIComponent(String(id)));
+		return this._request("DELETE", this._idUrl("", id));
 	}
 	/**
 	* `GET /meta` — table/view metadata (cached after first call).
@@ -348,6 +341,18 @@ var Client = class {
 		return this._postAction(action, body);
 	}
 	/**
+	* `GET /meta/actions/:id` or `GET /meta/actions?k1=v1&k2=v2` — the
+	* row-level actions the caller may run on one row right now, and the
+	* reasons of those disabled with one: `{ actions, disabledReasons? }`.
+	* Works for rows the caller cannot read; an unknown or out-of-scope id
+	* resolves to `{ actions: [] }`. Id forms as {@link one}.
+	*
+	* @since 0.1.145
+	*/
+	async availableActions(id) {
+		return this._request("GET", this._idUrl("meta/actions", id));
+	}
+	/**
 	* Fetches and caches the deserialized form schema for an action's
 	* `@InputForm()` parameter. Returns `null` when the action has no form
 	* declared, or doesn't exist on `/meta`. Callers typically pass the
@@ -442,6 +447,21 @@ var Client = class {
 		for (const [k, v] of Object.entries(id)) params.set(k, String(v));
 		return params;
 	}
+	/**
+	* The endpoint addressing one row under `base`: `base/<id>` for a scalar
+	* id, `base?k1=v1&k2=v2` for an object id; `query` (a query string) is
+	* appended.
+	*/
+	_idUrl(base, id, query = "") {
+		if (id !== null && typeof id === "object") {
+			const params = this._idToParams(id);
+			for (const [k, v] of new URLSearchParams(query)) params.set(k, v);
+			const qs = params.toString();
+			return qs ? `${base}?${qs}` : base;
+		}
+		const path = `${base ? `${base}/` : ""}${encodeURIComponent(String(id))}`;
+		return query ? `${path}?${query}` : path;
+	}
 	async _getOrNull(endpoint) {
 		try {
 			return await this._request("GET", endpoint);

package/dist/index.d.cts

@@ -1,7 +1,7 @@
 import { A as TDbDeleteResult, C as OwnOf, D as RowOf, E as RelationInfo, F as Uniquery, I as UniqueryControls, L as ValidGroupBy, M as TDbInsertResult, N as TDbUpdateResult, O as SearchIndexInfo, P as TypedWithRelation, R as WeekStart, S as NavOf, T as PatchOf, _ as DbRow, a as ValidatorMode, b as IdOf, c as AggregateResult, d as BucketUnit, f as CalendarBucketLabel, g as DbPatch, h as DataOf, j as TDbInsertManyResult, k as ServerError, l as AtscriptClientShape, m as ClientResponse, n as ClientValidator, p as ClientOptions, r as ClientValidatorOptions, s as AggregateQuery, t as ClientValidationError, u as BucketExpr, v as FieldMeta, w as PageResult, x as MetaResponse, y as FilterExpr } from "./validator-810-rhnQ.cjs";
 import { AggregateExpr, AggregateQuery as AggregateQuery$1, AggregateResult as AggregateResult$1, BucketExpr as BucketExpr$1, Uniquery as Uniquery$1, UniqueryControls as UniqueryControls$1, ValidGroupBy as ValidGroupBy$1, bucketStartInstant, nextBucketLabel } from "@uniqu/core";
 import { TAtscriptAnnotatedType, TSerializedAnnotatedType } from "@atscript/typescript/utils";
-import { TCrudOp, TCrudPermissions, TDbActionInfo, TDbActionIntent, TDbActionLevel, TDbActionProcessor, TDbDeleteResult as TDbDeleteResult$1, TDbInsertManyResult as TDbInsertManyResult$1, TDbInsertResult as TDbInsertResult$1, TDbUpdateResult as TDbUpdateResult$1 } from "@atscript/db";
+import { TCrudOp, TCrudPermissions, TDbActionInfo, TDbActionIntent, TDbActionLevel, TDbActionProcessor, TDbAvailableActions, TDbAvailableActions as TDbAvailableActions$1, TDbDeleteResult as TDbDeleteResult$1, TDbInsertManyResult as TDbInsertManyResult$1, TDbInsertResult as TDbInsertResult$1, TDbUpdateResult as TDbUpdateResult$1 } from "@atscript/db";
 
 //#region src/client.d.ts
 type Own<T> = OwnOf<T>;
@@ -171,6 +171,16 @@ declare class Client<T extends AtscriptClientShape = AtscriptClientShape> {
    *              `{ message?: string, ... }`); the client cannot validate.
    */
   action<R = unknown>(name: string, id?: Partial<Own<T>> | Partial<Own<T>>[], input?: unknown): Promise<R>;
+  /**
+   * `GET /meta/actions/:id` or `GET /meta/actions?k1=v1&k2=v2` — the
+   * row-level actions the caller may run on one row right now, and the
+   * reasons of those disabled with one: `{ actions, disabledReasons? }`.
+   * Works for rows the caller cannot read; an unknown or out-of-scope id
+   * resolves to `{ actions: [] }`. Id forms as {@link one}.
+   *
+   * @since 0.1.145
+   */
+  availableActions(id: Id<T>): Promise<TDbAvailableActions$1>;
   /**
    * Fetches and caches the deserialized form schema for an action's
    * `@InputForm()` parameter. Returns `null` when the action has no form
@@ -198,6 +208,12 @@ declare class Client<T extends AtscriptClientShape = AtscriptClientShape> {
   private _dispatchNavigate;
   private _postAction;
   private _idToParams;
+  /**
+   * The endpoint addressing one row under `base`: `base/<id>` for a scalar
+   * id, `base?k1=v1&k2=v2` for an object id; `query` (a query string) is
+   * appended.
+   */
+  private _idUrl;
   private _getOrNull;
   private _get;
   private _resolveHeaders;
@@ -366,4 +382,4 @@ declare class ActionUnsupportedError extends Error {
   constructor(action: string, processor: string, message: string);
 }
 //#endregion
-export { ActionDisabledError, type ActionDisabledErrorBody, ActionNotFoundError, ActionUnsupportedError, type AggregateQuery, type AggregateResult, type AtscriptClientShape, type BucketExpr, type BucketUnit, type CalendarBucketLabel, Client, ClientError, type ClientOptions, type ClientResponse, type ClientValidationError, type ClientValidator, type ClientValidatorOptions, type DataOf, type DbPatch, type DbRow, type FieldMeta, type FilterExpr, type IdOf, type MetaResponse, type NavOf, type OwnOf, type PageResult, type PatchOf, type RelationInfo, type RowOf, type SearchIndexInfo, type ServerError, type TCrudOp, type TCrudPermissions, type TDbActionInfo, type TDbActionIntent, type TDbActionLevel, type TDbActionProcessor, type TDbDeleteResult, type TDbInsertManyResult, type TDbInsertResult, type TDbUpdateResult, type TSerializedAnnotatedType, TransportError, type TypedWithRelation, type Uniquery, type UniqueryControls, type ValidGroupBy, type ValidatorMode, VersionMismatchError, type VersionMismatchErrorBody, type WeekStart, bucketStartInstant, encodeNavigateId, formatIdentifier, formatIdentifierField, nextBucketLabel };
+export { ActionDisabledError, type ActionDisabledErrorBody, ActionNotFoundError, ActionUnsupportedError, type AggregateQuery, type AggregateResult, type AtscriptClientShape, type BucketExpr, type BucketUnit, type CalendarBucketLabel, Client, ClientError, type ClientOptions, type ClientResponse, type ClientValidationError, type ClientValidator, type ClientValidatorOptions, type DataOf, type DbPatch, type DbRow, type FieldMeta, type FilterExpr, type IdOf, type MetaResponse, type NavOf, type OwnOf, type PageResult, type PatchOf, type RelationInfo, type RowOf, type SearchIndexInfo, type ServerError, type TCrudOp, type TCrudPermissions, type TDbActionInfo, type TDbActionIntent, type TDbActionLevel, type TDbActionProcessor, type TDbAvailableActions, type TDbDeleteResult, type TDbInsertManyResult, type TDbInsertResult, type TDbUpdateResult, type TSerializedAnnotatedType, TransportError, type TypedWithRelation, type Uniquery, type UniqueryControls, type ValidGroupBy, type ValidatorMode, VersionMismatchError, type VersionMismatchErrorBody, type WeekStart, bucketStartInstant, encodeNavigateId, formatIdentifier, formatIdentifierField, nextBucketLabel };

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import { A as TDbDeleteResult, C as OwnOf, D as RowOf, E as RelationInfo, F as Uniquery, I as UniqueryControls, L as ValidGroupBy, M as TDbInsertResult, N as TDbUpdateResult, O as SearchIndexInfo, P as TypedWithRelation, R as WeekStart, S as NavOf, T as PatchOf, _ as DbRow, a as ValidatorMode, b as IdOf, c as AggregateResult, d as BucketUnit, f as CalendarBucketLabel, g as DbPatch, h as DataOf, j as TDbInsertManyResult, k as ServerError, l as AtscriptClientShape, m as ClientResponse, n as ClientValidator, p as ClientOptions, r as ClientValidatorOptions, s as AggregateQuery, t as ClientValidationError, u as BucketExpr, v as FieldMeta, w as PageResult, x as MetaResponse, y as FilterExpr } from "./validator-CIm1ZCS5.mjs";
 import { TAtscriptAnnotatedType, TSerializedAnnotatedType } from "@atscript/typescript/utils";
 import { AggregateExpr, AggregateQuery as AggregateQuery$1, AggregateResult as AggregateResult$1, BucketExpr as BucketExpr$1, Uniquery as Uniquery$1, UniqueryControls as UniqueryControls$1, ValidGroupBy as ValidGroupBy$1, bucketStartInstant, nextBucketLabel } from "@uniqu/core";
-import { TCrudOp, TCrudPermissions, TDbActionInfo, TDbActionIntent, TDbActionLevel, TDbActionProcessor, TDbDeleteResult as TDbDeleteResult$1, TDbInsertManyResult as TDbInsertManyResult$1, TDbInsertResult as TDbInsertResult$1, TDbUpdateResult as TDbUpdateResult$1 } from "@atscript/db";
+import { TCrudOp, TCrudPermissions, TDbActionInfo, TDbActionIntent, TDbActionLevel, TDbActionProcessor, TDbAvailableActions, TDbAvailableActions as TDbAvailableActions$1, TDbDeleteResult as TDbDeleteResult$1, TDbInsertManyResult as TDbInsertManyResult$1, TDbInsertResult as TDbInsertResult$1, TDbUpdateResult as TDbUpdateResult$1 } from "@atscript/db";
 
 //#region src/client.d.ts
 type Own<T> = OwnOf<T>;
@@ -171,6 +171,16 @@ declare class Client<T extends AtscriptClientShape = AtscriptClientShape> {
    *              `{ message?: string, ... }`); the client cannot validate.
    */
   action<R = unknown>(name: string, id?: Partial<Own<T>> | Partial<Own<T>>[], input?: unknown): Promise<R>;
+  /**
+   * `GET /meta/actions/:id` or `GET /meta/actions?k1=v1&k2=v2` — the
+   * row-level actions the caller may run on one row right now, and the
+   * reasons of those disabled with one: `{ actions, disabledReasons? }`.
+   * Works for rows the caller cannot read; an unknown or out-of-scope id
+   * resolves to `{ actions: [] }`. Id forms as {@link one}.
+   *
+   * @since 0.1.145
+   */
+  availableActions(id: Id<T>): Promise<TDbAvailableActions$1>;
   /**
    * Fetches and caches the deserialized form schema for an action's
    * `@InputForm()` parameter. Returns `null` when the action has no form
@@ -198,6 +208,12 @@ declare class Client<T extends AtscriptClientShape = AtscriptClientShape> {
   private _dispatchNavigate;
   private _postAction;
   private _idToParams;
+  /**
+   * The endpoint addressing one row under `base`: `base/<id>` for a scalar
+   * id, `base?k1=v1&k2=v2` for an object id; `query` (a query string) is
+   * appended.
+   */
+  private _idUrl;
   private _getOrNull;
   private _get;
   private _resolveHeaders;
@@ -366,4 +382,4 @@ declare class ActionUnsupportedError extends Error {
   constructor(action: string, processor: string, message: string);
 }
 //#endregion
-export { ActionDisabledError, type ActionDisabledErrorBody, ActionNotFoundError, ActionUnsupportedError, type AggregateQuery, type AggregateResult, type AtscriptClientShape, type BucketExpr, type BucketUnit, type CalendarBucketLabel, Client, ClientError, type ClientOptions, type ClientResponse, type ClientValidationError, type ClientValidator, type ClientValidatorOptions, type DataOf, type DbPatch, type DbRow, type FieldMeta, type FilterExpr, type IdOf, type MetaResponse, type NavOf, type OwnOf, type PageResult, type PatchOf, type RelationInfo, type RowOf, type SearchIndexInfo, type ServerError, type TCrudOp, type TCrudPermissions, type TDbActionInfo, type TDbActionIntent, type TDbActionLevel, type TDbActionProcessor, type TDbDeleteResult, type TDbInsertManyResult, type TDbInsertResult, type TDbUpdateResult, type TSerializedAnnotatedType, TransportError, type TypedWithRelation, type Uniquery, type UniqueryControls, type ValidGroupBy, type ValidatorMode, VersionMismatchError, type VersionMismatchErrorBody, type WeekStart, bucketStartInstant, encodeNavigateId, formatIdentifier, formatIdentifierField, nextBucketLabel };
+export { ActionDisabledError, type ActionDisabledErrorBody, ActionNotFoundError, ActionUnsupportedError, type AggregateQuery, type AggregateResult, type AtscriptClientShape, type BucketExpr, type BucketUnit, type CalendarBucketLabel, Client, ClientError, type ClientOptions, type ClientResponse, type ClientValidationError, type ClientValidator, type ClientValidatorOptions, type DataOf, type DbPatch, type DbRow, type FieldMeta, type FilterExpr, type IdOf, type MetaResponse, type NavOf, type OwnOf, type PageResult, type PatchOf, type RelationInfo, type RowOf, type SearchIndexInfo, type ServerError, type TCrudOp, type TCrudPermissions, type TDbActionInfo, type TDbActionIntent, type TDbActionLevel, type TDbActionProcessor, type TDbAvailableActions, type TDbDeleteResult, type TDbInsertManyResult, type TDbInsertResult, type TDbUpdateResult, type TSerializedAnnotatedType, TransportError, type TypedWithRelation, type Uniquery, type UniqueryControls, type ValidGroupBy, type ValidatorMode, VersionMismatchError, type VersionMismatchErrorBody, type WeekStart, bucketStartInstant, encodeNavigateId, formatIdentifier, formatIdentifierField, nextBucketLabel };

package/dist/index.mjs

@@ -247,13 +247,7 @@ var Client = class {
 	*/
 	async one(id, query) {
 		const controlStr = query?.controls ? buildUrl({ controls: query.controls }) : "";
-		if (id !== null && typeof id === "object") {
-			const params = this._idToParams(id);
-			if (controlStr) for (const [k, v] of new URLSearchParams(controlStr)) params.set(k, v);
-			const qs = params.toString();
-			return this._getOrNull(`one${qs ? `?${qs}` : ""}`);
-		}
-		return this._getOrNull(`one/${encodeURIComponent(String(id))}${controlStr ? `?${controlStr}` : ""}`);
+		return this._getOrNull(this._idUrl("one", id, controlStr));
 	}
 	async insert(data) {
 		return this._request("POST", "", await this._prepareWrite(data, "insert"));
@@ -281,8 +275,7 @@ var Client = class {
 	* `DELETE /:id` or `DELETE /?k1=v1&k2=v2` — remove a record by primary key.
 	*/
 	async remove(id) {
-		if (id !== null && typeof id === "object") return this._request("DELETE", `?${this._idToParams(id).toString()}`);
-		return this._request("DELETE", encodeURIComponent(String(id)));
+		return this._request("DELETE", this._idUrl("", id));
 	}
 	/**
 	* `GET /meta` — table/view metadata (cached after first call).
@@ -347,6 +340,18 @@ var Client = class {
 		return this._postAction(action, body);
 	}
 	/**
+	* `GET /meta/actions/:id` or `GET /meta/actions?k1=v1&k2=v2` — the
+	* row-level actions the caller may run on one row right now, and the
+	* reasons of those disabled with one: `{ actions, disabledReasons? }`.
+	* Works for rows the caller cannot read; an unknown or out-of-scope id
+	* resolves to `{ actions: [] }`. Id forms as {@link one}.
+	*
+	* @since 0.1.145
+	*/
+	async availableActions(id) {
+		return this._request("GET", this._idUrl("meta/actions", id));
+	}
+	/**
 	* Fetches and caches the deserialized form schema for an action's
 	* `@InputForm()` parameter. Returns `null` when the action has no form
 	* declared, or doesn't exist on `/meta`. Callers typically pass the
@@ -441,6 +446,21 @@ var Client = class {
 		for (const [k, v] of Object.entries(id)) params.set(k, String(v));
 		return params;
 	}
+	/**
+	* The endpoint addressing one row under `base`: `base/<id>` for a scalar
+	* id, `base?k1=v1&k2=v2` for an object id; `query` (a query string) is
+	* appended.
+	*/
+	_idUrl(base, id, query = "") {
+		if (id !== null && typeof id === "object") {
+			const params = this._idToParams(id);
+			for (const [k, v] of new URLSearchParams(query)) params.set(k, v);
+			const qs = params.toString();
+			return qs ? `${base}?${qs}` : base;
+		}
+		const path = `${base ? `${base}/` : ""}${encodeURIComponent(String(id))}`;
+		return query ? `${path}?${query}` : path;
+	}
 	async _getOrNull(endpoint) {
 		try {
 			return await this._request("GET", endpoint);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atscript/db-client",
-  "version": "0.1.144",
+  "version": "0.1.145",
   "description": "Browser-compatible HTTP client for @atscript/moost-db REST endpoints.",
   "keywords": [
     "atscript",
@@ -47,14 +47,14 @@
     "@uniqu/url": "^0.1.11"
   },
   "devDependencies": {
-    "@atscript/core": "^0.1.96",
-    "@atscript/typescript": "^0.1.96",
-    "unplugin-atscript": "^0.1.96",
-    "@atscript/db": "0.1.144"
+    "@atscript/core": "^0.1.97",
+    "@atscript/typescript": "^0.1.97",
+    "unplugin-atscript": "^0.1.97",
+    "@atscript/db": "0.1.145"
   },
   "peerDependencies": {
     "@atscript/db": "^0.1.44",
-    "@atscript/typescript": "^0.1.96"
+    "@atscript/typescript": "^0.1.97"
   },
   "scripts": {
     "postinstall": "asc -f dts",