@danceroutine/tango-resources 1.11.3 → 1.11.4

package/dist/index-DkJtxvKu.d.ts

@@ -0,0 +1,164 @@
+import { r as RequestContext } from "./index-BJJalUDB.js";
+import { o as FilterSet } from "./index-CiIB-1Ac.js";
+import { i as Paginator } from "./CursorPaginator-CfeMQCdJ.js";
+import { C as ResourceModelMetadata, S as ResourceModelLike, g as SerializerOutput, n as AnyModelSerializer, r as AnyModelSerializerClass, x as ResourceModelFieldMetadata } from "./index-C55GDIOn.js";
+import { TangoResponse } from "@danceroutine/tango-core";
+import { ManagerLike, QuerySet } from "@danceroutine/tango-orm";
+
+//#region src/view/APIView.d.ts
+type APIViewMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+/**
+ * Lightweight class-based request dispatcher for non-model API endpoints.
+ */
+declare abstract class APIView {
+  static readonly BRAND: "tango.resources.api_view";
+  readonly __tangoBrand: typeof APIView.BRAND;
+  /**
+   * Narrow an unknown value to `APIView`.
+   */
+  static isAPIView(value: unknown): value is APIView;
+  /**
+   * Dispatch the request to the handler for the current HTTP method.
+   */
+  dispatch(ctx: RequestContext): Promise<TangoResponse>;
+  getAllowedMethods(): readonly APIViewMethod[];
+  protected get(_ctx: RequestContext): Promise<TangoResponse>;
+  protected post(_ctx: RequestContext): Promise<TangoResponse>;
+  protected put(_ctx: RequestContext): Promise<TangoResponse>;
+  protected patch(_ctx: RequestContext): Promise<TangoResponse>;
+  protected delete(_ctx: RequestContext): Promise<TangoResponse>;
+  protected httpMethodNotAllowed(): TangoResponse;
+  private getMethodHandler;
+}
+//#endregion
+//#region src/viewset/ModelViewSet.d.ts
+type ViewSetActionScope = 'detail' | 'collection';
+type ViewSetActionMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+interface ViewSetActionDescriptor {
+  name: string;
+  scope: ViewSetActionScope;
+  methods: readonly ViewSetActionMethod[];
+  path?: string;
+}
+interface ResolvedViewSetActionDescriptor extends ViewSetActionDescriptor {
+  path: string;
+}
+type AnyModelViewSet = ModelViewSet<Record<string, unknown>, AnyModelSerializerClass>;
+type SearchFieldRef$1<TModel extends Record<string, unknown>> = Extract<keyof TModel, string> | string;
+/**
+ * Configuration for a ModelViewSet, defining how a serializer-backed model is exposed as an API resource.
+ */
+interface ModelViewSetConfig<TModel extends Record<string, unknown>, TSerializer extends AnyModelSerializer<TModel>> {
+  /** Serializer class that owns validation, representation, and persistence hooks */
+  serializer: TSerializer;
+  /** Optional filter set defining which query parameters can filter the list endpoint */
+  filters?: FilterSet<TModel>;
+  /** Fields that clients are allowed to sort by via query parameters */
+  orderingFields?: (keyof TModel)[];
+  /** Fields that are searched when a free-text search query parameter is provided */
+  searchFields?: SearchFieldRef$1<TModel>[];
+  /** Optional paginator factory used by list endpoints. */
+  paginatorFactory?: (queryset: QuerySet<TModel>) => Paginator<TModel, SerializerOutput<TSerializer>>;
+}
+/**
+ * Base class for creating RESTful API viewsets with built-in CRUD operations.
+ * Provides list, retrieve, create, update, and delete methods with filtering,
+ * search, pagination, and ordering support.
+ */
+declare abstract class ModelViewSet<TModel extends Record<string, unknown>, TSerializer extends AnyModelSerializer<TModel>> {
+  static readonly BRAND: "tango.resources.model_view_set";
+  static readonly actions: readonly ViewSetActionDescriptor[];
+  readonly __tangoBrand: typeof ModelViewSet.BRAND;
+  protected readonly serializerClass: TSerializer;
+  protected readonly filters?: FilterSet<TModel>;
+  protected readonly orderingFields: (keyof TModel)[];
+  protected readonly searchFields: SearchFieldRef$1<TModel>[];
+  protected readonly paginatorFactory?: (queryset: QuerySet<TModel>) => Paginator<TModel, SerializerOutput<TSerializer>>;
+  private serializer?;
+  constructor(config: ModelViewSetConfig<TModel, TSerializer>);
+  /**
+   * Return the custom action descriptors declared by a viewset or constructor.
+   */
+  static getActions(viewsetOrConstructor: AnyModelViewSet | (new (...args: never[]) => AnyModelViewSet)): readonly ResolvedViewSetActionDescriptor[];
+  /**
+   * Narrow an unknown value to `ModelViewSet`.
+   */
+  static isModelViewSet(value: unknown): value is ModelViewSet<Record<string, unknown>, AnyModelSerializerClass>;
+  /**
+   * Preserve literal action inference while validating the descriptor shape.
+   */
+  static defineViewSetActions<const T extends readonly ViewSetActionDescriptor[]>(actions: T): T;
+  private static resolvePathFromDescriptor;
+  private static toKebabCase;
+  /**
+   * Return the serializer class that owns this resource contract.
+   */
+  getSerializerClass(): TSerializer;
+  /**
+   * Return the serializer instance for the current resource.
+   */
+  getSerializer(): InstanceType<TSerializer>;
+  /**
+   * Describe the public HTTP contract that this resource contributes to OpenAPI generation.
+   */
+  describeOpenAPI(): ModelViewSetOpenAPIDescription<TModel, TSerializer>;
+  /**
+   * List endpoint with filtering, search, ordering, and offset pagination.
+   */
+  list(ctx: RequestContext): Promise<TangoResponse>;
+  /**
+   * Retrieve endpoint for a single resource by id.
+   */
+  retrieve(_ctx: RequestContext, id: string): Promise<TangoResponse>;
+  /**
+   * Create endpoint: validate input, persist, and return serialized output.
+   */
+  create(ctx: RequestContext): Promise<TangoResponse>;
+  /**
+   * Update endpoint: validate partial payload and persist by id.
+   */
+  update(ctx: RequestContext, id: string): Promise<TangoResponse>;
+  /**
+   * Destroy endpoint: delete a resource by id.
+   */
+  destroy(_ctx: RequestContext, id: string): Promise<TangoResponse>;
+  protected getPaginator(queryset: QuerySet<TModel>): Paginator<TModel, SerializerOutput<TSerializer>>;
+  protected getManager(): ManagerLike<TModel>;
+  /**
+   * Convert thrown errors into normalized HTTP responses.
+   */
+  protected handleError(error: unknown): TangoResponse;
+  /**
+   * Resolve route path segment(s) for a custom action.
+   * Override this in subclasses to customize path derivation globally.
+   */
+  protected resolveActionPath(action: ViewSetActionDescriptor): string;
+  private requireModelMetadata;
+  private getLookupFieldFromMetadata;
+}
+//#endregion
+//#region src/resource/OpenAPIDescription.d.ts
+type SearchFieldRef<TModel extends Record<string, unknown>> = Extract<keyof TModel, string> | string;
+type GenericAPIViewOpenAPIDescription<TModel extends Record<string, unknown>, TSerializer extends AnyModelSerializer<TModel> = AnyModelSerializer<TModel>> = {
+  model: ResourceModelLike<TModel> & {
+    metadata: NonNullable<ResourceModelLike<TModel>['metadata']>;
+  };
+  outputSchema: TSerializer['outputSchema'];
+  createSchema: TSerializer['createSchema'];
+  updateSchema: TSerializer['updateSchema'];
+  searchFields: readonly SearchFieldRef<TModel>[];
+  orderingFields: readonly (keyof TModel)[];
+  lookupField: keyof TModel;
+  lookupParam: string;
+  allowedMethods: readonly APIViewMethod[];
+  usesDefaultOffsetPagination: boolean;
+};
+type ModelViewSetOpenAPIDescription<TModel extends Record<string, unknown>, TSerializer extends AnyModelSerializer<TModel> = AnyModelSerializer<TModel>> = GenericAPIViewOpenAPIDescription<TModel, TSerializer> & {
+  actions: readonly ResolvedViewSetActionDescriptor[];
+};
+declare namespace index_d_exports {
+  export { GenericAPIViewOpenAPIDescription, ModelViewSetOpenAPIDescription, ResourceModelFieldMetadata, ResourceModelLike, ResourceModelMetadata };
+}
+//#endregion
+export { ModelViewSetConfig as a, ViewSetActionMethod as c, APIViewMethod as d, ModelViewSet as i, ViewSetActionScope as l, GenericAPIViewOpenAPIDescription as n, ResolvedViewSetActionDescriptor as o, ModelViewSetOpenAPIDescription as r, ViewSetActionDescriptor as s, index_d_exports as t, APIView as u };
+//# sourceMappingURL=index-DkJtxvKu.d.ts.map

package/dist/index.d.ts

@@ -1,12 +1,10 @@
-import { $ as Page, A as ManyToManyManagerKeys, B as SerializerOutput, C as ViewSetActionMethod, D as AnyModelSerializerClass, E as AnyModelSerializer, F as relation, G as ResourceModelFieldMetadata, H as SerializerUpdateInput, I as AnySerializerClass, J as index_d_exports$2, K as ResourceModelLike, L as Serializer, M as ManyToManyRelationField, N as ManyToManyWriteStrategy, O as ModelSerializer, P as ModelSerializerRelationFields, Q as OffsetPaginator, R as SerializerClass, S as ViewSetActionDescriptor, T as index_d_exports$5, U as APIView, V as SerializerSchema, W as APIViewMethod, X as OffsetPaginationInput, Y as CursorPaginationInput, Z as CursorPaginator, _ as GenericAPIViewOpenAPIDescription, _t as RequestContext, a as ListCreateAPIView, at as index_d_exports$1, b as ModelViewSetConfig, c as ListAPIView, ct as FilterLookup, d as RetrieveModelMixin, dt as FilterSetDefineConfig, et as Paginator, f as CreateModelMixin, ft as FilterValueParser, g as index_d_exports$4, gt as BaseUser, h as GenericAPIViewConfig, ht as index_d_exports, i as RetrieveUpdateAPIView, it as PaginatedResponse, j as ManyToManyReadStrategy, k as ModelSerializerClass, l as DestroyModelMixin, lt as FilterResolver, m as GenericAPIView, mt as FilterType, n as RetrieveUpdateDestroyAPIView, nt as CursorPaginatedResponse, o as RetrieveAPIView, ot as AliasFilterDeclaration, p as ListModelMixin, pt as RangeOperator, q as ResourceModelMetadata, r as RetrieveDestroyAPIView, rt as OffsetPaginatedResponse, s as CreateAPIView, st as FieldFilterDeclaration, t as index_d_exports$6, tt as BasePaginatedResponse, u as UpdateModelMixin, ut as FilterSet, v as ModelViewSetOpenAPIDescription, w as ViewSetActionScope, x as ResolvedViewSetActionDescriptor, y as ModelViewSet, z as SerializerCreateInput } from "./index-D6sfTSEj.js";
-
-//#region src/paginators/index.d.ts
-declare namespace index_d_exports$3 {
-  export { CursorPaginator, OffsetPaginator };
-}
-declare namespace index_d_exports$7 {
-  export { ModelViewSet, ModelViewSetConfig, ModelViewSetOpenAPIDescription, ResolvedViewSetActionDescriptor, ViewSetActionDescriptor, ViewSetActionMethod, ViewSetActionScope };
-}
-//#endregion
-export { APIView, type APIViewMethod, type AliasFilterDeclaration, type AnyModelSerializer, type AnyModelSerializerClass, type AnySerializerClass, type BasePaginatedResponse, type BaseUser, CreateAPIView, CreateModelMixin, type CursorPaginatedResponse, CursorPaginationInput, CursorPaginator, DestroyModelMixin, type FieldFilterDeclaration, type FilterLookup, type FilterResolver, FilterSet, type FilterSetDefineConfig, type FilterType, type FilterValueParser, GenericAPIView, type GenericAPIViewConfig, type GenericAPIViewOpenAPIDescription, ListAPIView, ListCreateAPIView, ListModelMixin, type ManyToManyManagerKeys, type ManyToManyReadStrategy, type ManyToManyRelationField, type ManyToManyWriteStrategy, ModelSerializer, type ModelSerializerClass, type ModelSerializerRelationFields, ModelViewSet, type ModelViewSetConfig, type ModelViewSetOpenAPIDescription, type OffsetPaginatedResponse, OffsetPaginationInput, OffsetPaginator, type Page, type PaginatedResponse, type Paginator, type RangeOperator, RequestContext, type ResolvedViewSetActionDescriptor, type ResourceModelFieldMetadata, type ResourceModelLike, type ResourceModelMetadata, RetrieveAPIView, RetrieveDestroyAPIView, RetrieveModelMixin, RetrieveUpdateAPIView, RetrieveUpdateDestroyAPIView, Serializer, type SerializerClass, type SerializerCreateInput, type SerializerOutput, type SerializerSchema, type SerializerUpdateInput, UpdateModelMixin, type ViewSetActionDescriptor, type ViewSetActionMethod, type ViewSetActionScope, index_d_exports as context, index_d_exports$1 as filters, index_d_exports$2 as pagination, index_d_exports$3 as paginators, relation, index_d_exports$4 as resource, index_d_exports$5 as serializer, index_d_exports$6 as view, index_d_exports$7 as viewset };
-//# sourceMappingURL=index.d.ts.map
+import { n as BaseUser, r as RequestContext, t as index_d_exports } from "./index-BJJalUDB.js";
+import { a as FilterResolver, c as FilterValueParser, i as FilterLookup, l as RangeOperator, n as AliasFilterDeclaration, o as FilterSet, r as FieldFilterDeclaration, s as FilterSetDefineConfig, t as index_d_exports$1, u as FilterType } from "./index-CiIB-1Ac.js";
+import { a as BasePaginatedResponse, c as PaginatedResponse, i as Paginator, n as OffsetPaginator, o as CursorPaginatedResponse, r as Page, s as OffsetPaginatedResponse, t as CursorPaginator } from "./CursorPaginator-CfeMQCdJ.js";
+import { i as OffsetPaginationInput, n as CursorPaginationInput, t as index_d_exports$2 } from "./index-Ac94YL5S.js";
+import { t as index_d_exports$3 } from "./paginators/index.js";
+import { C as ResourceModelMetadata, S as ResourceModelLike, a as ModelSerializerClass, b as SerializerUpdateInput, c as ManyToManyRelationField, d as relation, f as AnySerializerClass, g as SerializerOutput, h as SerializerCreateInput, i as ModelSerializer, l as ManyToManyWriteStrategy, m as SerializerClass, n as AnyModelSerializer, o as ManyToManyManagerKeys, p as Serializer, r as AnyModelSerializerClass, s as ManyToManyReadStrategy, t as index_d_exports$5, u as ModelSerializerRelationFields, x as ResourceModelFieldMetadata, y as SerializerSchema } from "./index-C55GDIOn.js";
+import { a as ModelViewSetConfig, c as ViewSetActionMethod, d as APIViewMethod, i as ModelViewSet, l as ViewSetActionScope, n as GenericAPIViewOpenAPIDescription, o as ResolvedViewSetActionDescriptor, r as ModelViewSetOpenAPIDescription, s as ViewSetActionDescriptor, t as index_d_exports$4, u as APIView } from "./index-DkJtxvKu.js";
+import { t as index_d_exports$7 } from "./viewset/index.js";
+import { a as ListCreateAPIView, c as ListAPIView, d as RetrieveModelMixin, f as CreateModelMixin, h as GenericAPIViewConfig, i as RetrieveUpdateAPIView, l as DestroyModelMixin, m as GenericAPIView, n as RetrieveUpdateDestroyAPIView, o as RetrieveAPIView, p as ListModelMixin, r as RetrieveDestroyAPIView, s as CreateAPIView, t as index_d_exports$6, u as UpdateModelMixin } from "./index-Bg6TtnmQ.js";
+export { APIView, type APIViewMethod, type AliasFilterDeclaration, type AnyModelSerializer, type AnyModelSerializerClass, type AnySerializerClass, type BasePaginatedResponse, type BaseUser, CreateAPIView, CreateModelMixin, type CursorPaginatedResponse, CursorPaginationInput, CursorPaginator, DestroyModelMixin, type FieldFilterDeclaration, type FilterLookup, type FilterResolver, FilterSet, type FilterSetDefineConfig, type FilterType, type FilterValueParser, GenericAPIView, type GenericAPIViewConfig, type GenericAPIViewOpenAPIDescription, ListAPIView, ListCreateAPIView, ListModelMixin, type ManyToManyManagerKeys, type ManyToManyReadStrategy, type ManyToManyRelationField, type ManyToManyWriteStrategy, ModelSerializer, type ModelSerializerClass, type ModelSerializerRelationFields, ModelViewSet, type ModelViewSetConfig, type ModelViewSetOpenAPIDescription, type OffsetPaginatedResponse, OffsetPaginationInput, OffsetPaginator, type Page, type PaginatedResponse, type Paginator, type RangeOperator, RequestContext, type ResolvedViewSetActionDescriptor, type ResourceModelFieldMetadata, type ResourceModelLike, type ResourceModelMetadata, RetrieveAPIView, RetrieveDestroyAPIView, RetrieveModelMixin, RetrieveUpdateAPIView, RetrieveUpdateDestroyAPIView, Serializer, type SerializerClass, type SerializerCreateInput, type SerializerOutput, type SerializerSchema, type SerializerUpdateInput, UpdateModelMixin, type ViewSetActionDescriptor, type ViewSetActionMethod, type ViewSetActionScope, index_d_exports as context, index_d_exports$1 as filters, index_d_exports$2 as pagination, index_d_exports$3 as paginators, relation, index_d_exports$4 as resource, index_d_exports$5 as serializer, index_d_exports$6 as view, index_d_exports$7 as viewset };