@danceroutine/tango-resources 0.1.0 → 1.0.0

package/dist/serializer/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Domain boundary barrel: centralizes this subdomain's public contract.
+ */
+export { Serializer, type SerializerClass, type AnySerializerClass, type SerializerCreateInput, type SerializerUpdateInput, type SerializerOutput, type SerializerSchema, } from './Serializer';
+export { ModelSerializer, type ModelSerializerClass, type AnyModelSerializerClass } from './ModelSerializer';

package/dist/view/APIView.d.ts

@@ -0,0 +1,26 @@
+import { TangoResponse } from '@danceroutine/tango-core';
+import { RequestContext } from '../context/index';
+export type APIViewMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+/**
+ * Lightweight class-based request dispatcher for non-model API endpoints.
+ */
+export 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;
+}

package/dist/view/GenericAPIView.d.ts

@@ -0,0 +1,57 @@
+import { TangoResponse } from '@danceroutine/tango-core';
+import { type ManagerLike, type QuerySet } from '@danceroutine/tango-orm';
+import type { Paginator } from '../pagination/index';
+import { APIView } from './APIView';
+import { RequestContext } from '../context/index';
+import type { FilterSet } from '../filters/index';
+import type { GenericAPIViewOpenAPIDescription } from '../resource/index';
+import type { ModelSerializerClass, SerializerOutput, SerializerSchema } from '../serializer/index';
+export interface GenericAPIViewConfig<TModel extends Record<string, unknown>, TSerializer extends ModelSerializerClass<TModel, SerializerSchema, SerializerSchema, SerializerSchema>> {
+    serializer: TSerializer;
+    filters?: FilterSet<TModel>;
+    orderingFields?: (keyof TModel)[];
+    searchFields?: (keyof TModel)[];
+    lookupField?: keyof TModel;
+    lookupParam?: string;
+    paginatorFactory?: (queryset: QuerySet<TModel>) => Paginator<TModel, SerializerOutput<TSerializer>>;
+}
+/**
+ * Generic API base class that centralizes query/build/validation helpers.
+ */
+export declare abstract class GenericAPIView<TModel extends Record<string, unknown>, TSerializer extends ModelSerializerClass<TModel, SerializerSchema, SerializerSchema, SerializerSchema>> extends APIView {
+    protected readonly serializerClass: TSerializer;
+    protected readonly filters?: FilterSet<TModel>;
+    protected readonly orderingFields: readonly (keyof TModel)[];
+    protected readonly searchFields: readonly (keyof TModel)[];
+    protected readonly lookupField?: keyof TModel;
+    protected readonly lookupParam: string;
+    protected readonly paginatorFactory?: (queryset: QuerySet<TModel>) => Paginator<TModel, SerializerOutput<TSerializer>>;
+    private serializer?;
+    constructor(config: GenericAPIViewConfig<TModel, TSerializer>);
+    /**
+     * 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(): GenericAPIViewOpenAPIDescription<TModel, TSerializer>;
+    protected getManager(): ManagerLike<TModel>;
+    protected getOutputSchema(): TSerializer['outputSchema'];
+    protected getCreateSchema(): TSerializer['createSchema'];
+    protected getUpdateSchema(): TSerializer['updateSchema'];
+    protected getLookupField(): keyof TModel;
+    protected getLookupValue(ctx: RequestContext): string | null;
+    protected getPaginator(queryset: QuerySet<TModel>): Paginator<TModel, SerializerOutput<TSerializer>>;
+    protected performList(ctx: RequestContext): Promise<TangoResponse>;
+    protected performCreate(ctx: RequestContext): Promise<TangoResponse>;
+    protected performRetrieve(ctx: RequestContext): Promise<TangoResponse>;
+    protected performUpdate(ctx: RequestContext): Promise<TangoResponse>;
+    protected performDestroy(ctx: RequestContext): Promise<TangoResponse>;
+    protected handleError(error: unknown): TangoResponse;
+    private requireModelMetadata;
+}

package/dist/view/generics/CreateAPIView.d.ts

@@ -0,0 +1,10 @@
+import { CreateModelMixin } from '../mixins/CreateModelMixin';
+import type { TangoResponse } from '@danceroutine/tango-core';
+import { RequestContext } from '../../context/index';
+import type { ModelSerializerClass, SerializerSchema } from '../../serializer/index';
+/**
+ * Generic API view for endpoints that only support resource creation.
+ */
+export declare abstract class CreateAPIView<TModel extends Record<string, unknown>, TSerializer extends ModelSerializerClass<TModel, SerializerSchema, SerializerSchema, SerializerSchema>> extends CreateModelMixin<TModel, TSerializer> {
+    protected post(ctx: RequestContext): Promise<TangoResponse>;
+}

package/dist/view/generics/ListAPIView.d.ts

@@ -0,0 +1,10 @@
+import { ListModelMixin } from '../mixins/ListModelMixin';
+import type { TangoResponse } from '@danceroutine/tango-core';
+import { RequestContext } from '../../context/index';
+import type { ModelSerializerClass, SerializerSchema } from '../../serializer/index';
+/**
+ * Generic API view for endpoints that only expose a list operation.
+ */
+export declare abstract class ListAPIView<TModel extends Record<string, unknown>, TSerializer extends ModelSerializerClass<TModel, SerializerSchema, SerializerSchema, SerializerSchema>> extends ListModelMixin<TModel, TSerializer> {
+    protected get(ctx: RequestContext): Promise<TangoResponse>;
+}

package/dist/view/generics/ListCreateAPIView.d.ts

@@ -0,0 +1,11 @@
+import { GenericAPIView } from '../GenericAPIView';
+import type { TangoResponse } from '@danceroutine/tango-core';
+import { RequestContext } from '../../context/index';
+import type { ModelSerializerClass, SerializerSchema } from '../../serializer/index';
+/**
+ * Generic API view for collection endpoints that list and create resources.
+ */
+export declare abstract class ListCreateAPIView<TModel extends Record<string, unknown>, TSerializer extends ModelSerializerClass<TModel, SerializerSchema, SerializerSchema, SerializerSchema>> extends GenericAPIView<TModel, TSerializer> {
+    protected get(ctx: RequestContext): Promise<TangoResponse>;
+    protected post(ctx: RequestContext): Promise<TangoResponse>;
+}

package/dist/view/generics/RetrieveAPIView.d.ts

@@ -0,0 +1,10 @@
+import { RetrieveModelMixin } from '../mixins/RetrieveModelMixin';
+import type { TangoResponse } from '@danceroutine/tango-core';
+import { RequestContext } from '../../context/index';
+import type { ModelSerializerClass, SerializerSchema } from '../../serializer/index';
+/**
+ * Generic API view for endpoints that retrieve a single resource by lookup.
+ */
+export declare abstract class RetrieveAPIView<TModel extends Record<string, unknown>, TSerializer extends ModelSerializerClass<TModel, SerializerSchema, SerializerSchema, SerializerSchema>> extends RetrieveModelMixin<TModel, TSerializer> {
+    protected get(ctx: RequestContext): Promise<TangoResponse>;
+}

package/dist/view/generics/RetrieveDestroyAPIView.d.ts

@@ -0,0 +1,11 @@
+import { GenericAPIView } from '../GenericAPIView';
+import type { TangoResponse } from '@danceroutine/tango-core';
+import { RequestContext } from '../../context/index';
+import type { ModelSerializerClass, SerializerSchema } from '../../serializer/index';
+/**
+ * Generic API view for endpoints that retrieve and delete a single resource.
+ */
+export declare abstract class RetrieveDestroyAPIView<TModel extends Record<string, unknown>, TSerializer extends ModelSerializerClass<TModel, SerializerSchema, SerializerSchema, SerializerSchema>> extends GenericAPIView<TModel, TSerializer> {
+    protected get(ctx: RequestContext): Promise<TangoResponse>;
+    protected delete(ctx: RequestContext): Promise<TangoResponse>;
+}

package/dist/view/generics/RetrieveUpdateAPIView.d.ts

@@ -0,0 +1,12 @@
+import { GenericAPIView } from '../GenericAPIView';
+import type { TangoResponse } from '@danceroutine/tango-core';
+import { RequestContext } from '../../context/index';
+import type { ModelSerializerClass, SerializerSchema } from '../../serializer/index';
+/**
+ * Generic API view for endpoints that retrieve and update a single resource.
+ */
+export declare abstract class RetrieveUpdateAPIView<TModel extends Record<string, unknown>, TSerializer extends ModelSerializerClass<TModel, SerializerSchema, SerializerSchema, SerializerSchema>> extends GenericAPIView<TModel, TSerializer> {
+    protected get(ctx: RequestContext): Promise<TangoResponse>;
+    protected put(ctx: RequestContext): Promise<TangoResponse>;
+    protected patch(ctx: RequestContext): Promise<TangoResponse>;
+}

package/dist/view/generics/RetrieveUpdateDestroyAPIView.d.ts

@@ -0,0 +1,13 @@
+import { GenericAPIView } from '../GenericAPIView';
+import type { TangoResponse } from '@danceroutine/tango-core';
+import { RequestContext } from '../../context/index';
+import type { ModelSerializerClass, SerializerSchema } from '../../serializer/index';
+/**
+ * Generic API view for full detail endpoints that retrieve, update, and delete.
+ */
+export declare abstract class RetrieveUpdateDestroyAPIView<TModel extends Record<string, unknown>, TSerializer extends ModelSerializerClass<TModel, SerializerSchema, SerializerSchema, SerializerSchema>> extends GenericAPIView<TModel, TSerializer> {
+    protected get(ctx: RequestContext): Promise<TangoResponse>;
+    protected put(ctx: RequestContext): Promise<TangoResponse>;
+    protected patch(ctx: RequestContext): Promise<TangoResponse>;
+    protected delete(ctx: RequestContext): Promise<TangoResponse>;
+}

package/dist/view/generics/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Domain boundary barrel: centralizes this subdomain's public contract.
+ */
+export { ListAPIView } from './ListAPIView';
+export { CreateAPIView } from './CreateAPIView';
+export { RetrieveAPIView } from './RetrieveAPIView';
+export { ListCreateAPIView } from './ListCreateAPIView';
+export { RetrieveUpdateAPIView } from './RetrieveUpdateAPIView';
+export { RetrieveDestroyAPIView } from './RetrieveDestroyAPIView';
+export { RetrieveUpdateDestroyAPIView } from './RetrieveUpdateDestroyAPIView';

package/dist/view/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Domain boundary barrel: centralizes this subdomain's public contract.
+ */
+export { APIView, type APIViewMethod } from './APIView';
+export { GenericAPIView, type GenericAPIViewConfig } from './GenericAPIView';
+export type { GenericAPIViewOpenAPIDescription } from '../resource/index';
+export { ListModelMixin, CreateModelMixin, RetrieveModelMixin, UpdateModelMixin, DestroyModelMixin, } from './mixins/index';
+export { ListAPIView, CreateAPIView, RetrieveAPIView, ListCreateAPIView, RetrieveUpdateAPIView, RetrieveDestroyAPIView, RetrieveUpdateDestroyAPIView, } from './generics/index';

package/dist/view/index.js

@@ -0,0 +1,3 @@
+import { APIView, CreateAPIView, CreateModelMixin, DestroyModelMixin, GenericAPIView, ListAPIView, ListCreateAPIView, ListModelMixin, RetrieveAPIView, RetrieveDestroyAPIView, RetrieveModelMixin, RetrieveUpdateAPIView, RetrieveUpdateDestroyAPIView, UpdateModelMixin } from "../view-BNGEURL_.js";
+
+export { APIView, CreateAPIView, CreateModelMixin, DestroyModelMixin, GenericAPIView, ListAPIView, ListCreateAPIView, ListModelMixin, RetrieveAPIView, RetrieveDestroyAPIView, RetrieveModelMixin, RetrieveUpdateAPIView, RetrieveUpdateDestroyAPIView, UpdateModelMixin };

package/dist/view/mixins/CreateModelMixin.d.ts

@@ -0,0 +1,11 @@
+import { GenericAPIView } from '../GenericAPIView';
+import type { TangoResponse } from '@danceroutine/tango-core';
+import { RequestContext } from '../../context/index';
+import type { ModelSerializerClass, SerializerSchema } from '../../serializer/index';
+/**
+ * Mixin that wires `POST` requests to the generic create implementation.
+ */
+export declare abstract class CreateModelMixin<TModel extends Record<string, unknown>, TSerializer extends ModelSerializerClass<TModel, SerializerSchema, SerializerSchema, SerializerSchema>> extends GenericAPIView<TModel, TSerializer> {
+    protected create(ctx: RequestContext): Promise<TangoResponse>;
+    protected post(ctx: RequestContext): Promise<TangoResponse>;
+}

package/dist/view/mixins/DestroyModelMixin.d.ts

@@ -0,0 +1,11 @@
+import { GenericAPIView } from '../GenericAPIView';
+import type { TangoResponse } from '@danceroutine/tango-core';
+import { RequestContext } from '../../context/index';
+import type { ModelSerializerClass, SerializerSchema } from '../../serializer/index';
+/**
+ * Mixin that wires `DELETE` requests to the generic destroy implementation.
+ */
+export declare abstract class DestroyModelMixin<TModel extends Record<string, unknown>, TSerializer extends ModelSerializerClass<TModel, SerializerSchema, SerializerSchema, SerializerSchema>> extends GenericAPIView<TModel, TSerializer> {
+    protected destroy(ctx: RequestContext): Promise<TangoResponse>;
+    protected delete(ctx: RequestContext): Promise<TangoResponse>;
+}

package/dist/view/mixins/ListModelMixin.d.ts

@@ -0,0 +1,11 @@
+import { GenericAPIView } from '../GenericAPIView';
+import type { TangoResponse } from '@danceroutine/tango-core';
+import { RequestContext } from '../../context/index';
+import type { ModelSerializerClass, SerializerSchema } from '../../serializer/index';
+/**
+ * Mixin that wires `GET` requests to the generic list implementation.
+ */
+export declare abstract class ListModelMixin<TModel extends Record<string, unknown>, TSerializer extends ModelSerializerClass<TModel, SerializerSchema, SerializerSchema, SerializerSchema>> extends GenericAPIView<TModel, TSerializer> {
+    protected list(ctx: RequestContext): Promise<TangoResponse>;
+    protected get(ctx: RequestContext): Promise<TangoResponse>;
+}

package/dist/view/mixins/RetrieveModelMixin.d.ts

@@ -0,0 +1,11 @@
+import { GenericAPIView } from '../GenericAPIView';
+import type { TangoResponse } from '@danceroutine/tango-core';
+import { RequestContext } from '../../context/index';
+import type { ModelSerializerClass, SerializerSchema } from '../../serializer/index';
+/**
+ * Mixin that wires `GET` requests to the generic retrieve implementation.
+ */
+export declare abstract class RetrieveModelMixin<TModel extends Record<string, unknown>, TSerializer extends ModelSerializerClass<TModel, SerializerSchema, SerializerSchema, SerializerSchema>> extends GenericAPIView<TModel, TSerializer> {
+    protected retrieve(ctx: RequestContext): Promise<TangoResponse>;
+    protected get(ctx: RequestContext): Promise<TangoResponse>;
+}

package/dist/view/mixins/UpdateModelMixin.d.ts

@@ -0,0 +1,12 @@
+import { GenericAPIView } from '../GenericAPIView';
+import type { TangoResponse } from '@danceroutine/tango-core';
+import { RequestContext } from '../../context/index';
+import type { ModelSerializerClass, SerializerSchema } from '../../serializer/index';
+/**
+ * Mixin that wires `PUT` and `PATCH` requests to the generic update implementation.
+ */
+export declare abstract class UpdateModelMixin<TModel extends Record<string, unknown>, TSerializer extends ModelSerializerClass<TModel, SerializerSchema, SerializerSchema, SerializerSchema>> extends GenericAPIView<TModel, TSerializer> {
+    protected update(ctx: RequestContext): Promise<TangoResponse>;
+    protected put(ctx: RequestContext): Promise<TangoResponse>;
+    protected patch(ctx: RequestContext): Promise<TangoResponse>;
+}

package/dist/view/mixins/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Domain boundary barrel: centralizes this subdomain's public contract.
+ */
+export { ListModelMixin } from './ListModelMixin';
+export { CreateModelMixin } from './CreateModelMixin';
+export { RetrieveModelMixin } from './RetrieveModelMixin';
+export { UpdateModelMixin } from './UpdateModelMixin';
+export { DestroyModelMixin } from './DestroyModelMixin';