@zenstackhq/server 3.0.0-beta.13 → 3.0.0-beta.14

package/dist/api.d.ts

@@ -1,12 +1,130 @@
-import { SchemaDef } from '@zenstackhq/runtime/schema';
-import { A as ApiHandler, L as LogConfig, R as RequestContext, a as Response } from './types-BH-88xJo.js';
-import '@zenstackhq/runtime';
+import { SchemaDef } from '@zenstackhq/orm/schema';
+import { A as ApiHandler, L as LogConfig, R as RequestContext, a as Response } from './types-D5t0sUEw.js';
+import '@zenstackhq/orm';
+
+/**
+ * Options for {@link RestApiHandler}
+ */
+type RestApiHandlerOptions<Schema extends SchemaDef = SchemaDef> = {
+    /**
+     * The schema
+     */
+    schema: Schema;
+    /**
+     * Logging configuration
+     */
+    log?: LogConfig;
+    /**
+     * The base endpoint of the RESTful API, must be a valid URL
+     */
+    endpoint: string;
+    /**
+     * The default page size for limiting the number of results returned
+     * from collection queries, including resource collection, related data
+     * of collection types, and relationship of collection types.
+     *
+     * Defaults to 100. Set to Infinity to disable pagination.
+     */
+    pageSize?: number;
+    /**
+     * The divider used to separate compound ID fields in the URL.
+     * Defaults to '_'.
+     */
+    idDivider?: string;
+    /**
+     * The charset used for URL segment values. Defaults to `a-zA-Z0-9-_~ %`. You can change it if your entity's ID values
+     * allow different characters. Specifically, if your models use compound IDs and the idDivider is set to a different value,
+     * it should be included in the charset.
+     */
+    urlSegmentCharset?: string;
+    modelNameMapping?: Record<string, string>;
+    externalIdMapping?: Record<string, string>;
+};
+/**
+ * RESTful-style API request handler (compliant with JSON:API)
+ */
+declare class RestApiHandler<Schema extends SchemaDef> implements ApiHandler<Schema> {
+    private readonly options;
+    private serializers;
+    private readonly errors;
+    private filterParamPattern;
+    private createUpdatePayloadSchema;
+    private updateSingleRelationSchema;
+    private updateCollectionRelationSchema;
+    private upsertMetaSchema;
+    private typeMap;
+    private idDivider;
+    private urlPatternMap;
+    private modelNameMapping;
+    private reverseModelNameMapping;
+    private externalIdMapping;
+    constructor(options: RestApiHandlerOptions<Schema>);
+    get schema(): Schema;
+    get log(): LogConfig | undefined;
+    private buildUrlPatternMap;
+    private mapModelName;
+    private matchUrlPattern;
+    handleRequest({ client, method, path, query, requestBody }: RequestContext<Schema>): Promise<Response>;
+    private handleGenericError;
+    private processSingleRead;
+    private processFetchRelated;
+    private processReadRelationship;
+    private processCollectionRead;
+    private buildPartialSelect;
+    private addTotalCountToMeta;
+    private makePaginator;
+    private processRequestBody;
+    private processCreate;
+    private processUpsert;
+    private getUniqueFieldSets;
+    private processRelationshipCRUD;
+    private processUpdate;
+    private processDelete;
+    private requireModel;
+    private getIdFields;
+    private requireField;
+    private buildTypeMap;
+    private getModelInfo;
+    private makeLinkUrl;
+    private buildSerializers;
+    private getId;
+    private serializeItems;
+    private injectCompoundId;
+    private toPlainObject;
+    private replaceURLSearchParams;
+    private makeIdFilter;
+    private makeIdSelect;
+    private makeIdConnect;
+    private makeIdKey;
+    private makeDefaultIdKey;
+    private makeCompoundId;
+    private makeUpsertWhere;
+    private includeRelationshipIds;
+    private coerce;
+    private makeNormalizedUrl;
+    private getPagination;
+    private buildFilter;
+    private buildSort;
+    private buildRelationSelect;
+    private makeFilterValue;
+    private injectRelationQuery;
+    private handleZenStackError;
+    private makeError;
+    private makeUnsupportedModelError;
+    private makeUnsupportedRelationshipError;
+}
 
 /**
  * Options for {@link RPCApiHandler}
  */
 type RPCApiHandlerOptions<Schema extends SchemaDef> = {
+    /**
+     * The schema
+     */
     schema: Schema;
+    /**
+     * Logging configuration
+     */
     log?: LogConfig;
 };
 /**
@@ -16,6 +134,7 @@ declare class RPCApiHandler<Schema extends SchemaDef> implements ApiHandler<Sche
     private readonly options;
     constructor(options: RPCApiHandlerOptions<Schema>);
     get schema(): Schema;
+    get log(): LogConfig | undefined;
     handleRequest({ client, method, path, query, requestBody }: RequestContext<Schema>): Promise<Response>;
     private isValidModel;
     private makeBadInputErrorResponse;
@@ -25,4 +144,4 @@ declare class RPCApiHandler<Schema extends SchemaDef> implements ApiHandler<Sche
     private unmarshalQ;
 }
 
-export { RPCApiHandler };
+export { RPCApiHandler, type RPCApiHandlerOptions, RestApiHandler, type RestApiHandlerOptions };