@furystack/rest 8.0.22 → 8.0.24

package/esm/api-endpoint-schema.d.ts

@@ -0,0 +1,43 @@
+import type { Method } from './methods.js';
+/**
+ * The JSON schema type used for API endpoint definitions.
+ */
+export type Schema = unknown;
+/**
+ * Represents the definition of an API endpoint, including its method, path, schema, and schema name.
+ */
+export type ApiEndpointDefinition = {
+    /**
+     * The HTTP method for the endpoint (e.g., GET, POST, PUT, DELETE).
+     */
+    method: Method;
+    /**
+     * The path of the endpoint, which is the URL pattern that the endpoint responds to.
+     */
+    path: string;
+    /**
+     * The JSON schema that defines the structure of the request and response for this endpoint.
+     * To include a schema, wrap your endpoint with a Validate({...}) call during the implementation.
+     */
+    schema: Schema;
+    /**
+     * The name of the schema, which can be used to reference this schema in documentation or other contexts.
+     * To include a schema name, wrap your endpoint with a Validate({...}) call during the implementation.
+     */
+    schemaName: string;
+    /**
+     * Indicates whether the endpoint requires authentication.
+     * To include the flag, wrap your endpoint with an Authenticat() call during the implementation.
+     */
+    isAuthenticated: boolean;
+};
+/**
+ * Represents the schema for an API, which is a record of endpoint definitions keyed by their paths.
+ */
+export type ApiEndpointSchema = {
+    name: string;
+    description: string;
+    version: string;
+    endpoints: Record<string, ApiEndpointDefinition>;
+};
+//# sourceMappingURL=api-endpoint-schema.d.ts.map

package/esm/api-endpoint-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-endpoint-schema.d.ts","sourceRoot":"","sources":["../src/api-endpoint-schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAE1C;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,OAAO,CAAA;AAE5B;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,eAAe,EAAE,OAAO,CAAA;CACzB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;CACjD,CAAA"}

package/esm/api-endpoint-schema.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=api-endpoint-schema.js.map

package/esm/api-endpoint-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-endpoint-schema.js","sourceRoot":"","sources":["../src/api-endpoint-schema.ts"],"names":[],"mappings":""}

package/esm/index.d.ts

@@ -1,7 +1,9 @@
+export * from './api-endpoint-schema.js';
 export * from './deserialize-query-string.js';
+export * from './endpoint-models/index.js';
 export * from './methods.js';
-export * from './rest-api.js';
 export * from './request-error.js';
-export * from './endpoint-models/index.js';
+export * from './rest-api.js';
 export * from './serialize-to-query-string.js';
+export * from './swagger-document.js';
 //# sourceMappingURL=index.d.ts.map

package/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,+BAA+B,CAAA;AAC7C,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,oBAAoB,CAAA;AAClC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,gCAAgC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAA;AACxC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,4BAA4B,CAAA;AAC1C,cAAc,cAAc,CAAA;AAC5B,cAAc,oBAAoB,CAAA;AAClC,cAAc,eAAe,CAAA;AAC7B,cAAc,gCAAgC,CAAA;AAC9C,cAAc,uBAAuB,CAAA"}

package/esm/index.js

@@ -1,7 +1,9 @@
+export * from './api-endpoint-schema.js';
 export * from './deserialize-query-string.js';
+export * from './endpoint-models/index.js';
 export * from './methods.js';
-export * from './rest-api.js';
 export * from './request-error.js';
-export * from './endpoint-models/index.js';
+export * from './rest-api.js';
 export * from './serialize-to-query-string.js';
+export * from './swagger-document.js';
 //# sourceMappingURL=index.js.map

package/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,+BAA+B,CAAA;AAC7C,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,oBAAoB,CAAA;AAClC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,gCAAgC,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAA;AACxC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,4BAA4B,CAAA;AAC1C,cAAc,cAAc,CAAA;AAC5B,cAAc,oBAAoB,CAAA;AAClC,cAAc,eAAe,CAAA;AAC7B,cAAc,gCAAgC,CAAA;AAC9C,cAAc,uBAAuB,CAAA"}

package/esm/rest-api.d.ts

@@ -1,4 +1,6 @@
+import type { ApiEndpointSchema } from './api-endpoint-schema.js';
 import type { Method } from './methods.js';
+import type { SwaggerDocument } from './swagger-document.js';
 export type RestApi = {
     [TMethod in Method]?: {
         [TUrl: string]: {
@@ -10,4 +12,21 @@ export type RestApi = {
         };
     };
 };
+/**
+ * Represents an API with a GET action to retrieve its schema.
+ * This type extends the base RestApi type to include a specific GET endpoint for schema retrieval.
+ */
+export type WithSchemaAction<T extends RestApi> = T & {
+    GET: {
+        '/schema': {
+            result: ApiEndpointSchema;
+            headers: {
+                accept: 'application/schema+json';
+            };
+        };
+        '/swagger.json': {
+            result: SwaggerDocument;
+        };
+    };
+};
 //# sourceMappingURL=rest-api.d.ts.map

package/esm/rest-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rest-api.d.ts","sourceRoot":"","sources":["../src/rest-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAE1C,MAAM,MAAM,OAAO,GAAG;KACnB,OAAO,IAAI,MAAM,CAAC,CAAC,EAAE;QACpB,CAAC,IAAI,EAAE,MAAM,GAAG;YAAE,MAAM,EAAE,OAAO,CAAC;YAAC,GAAG,CAAC,EAAE,OAAO,CAAC;YAAC,KAAK,CAAC,EAAE,OAAO,CAAC;YAAC,IAAI,CAAC,EAAE,OAAO,CAAC;YAAC,OAAO,CAAC,EAAE,OAAO,CAAA;SAAE,CAAA;KACvG;CACF,CAAA"}
+{"version":3,"file":"rest-api.d.ts","sourceRoot":"","sources":["../src/rest-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AACjE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAE5D,MAAM,MAAM,OAAO,GAAG;KACnB,OAAO,IAAI,MAAM,CAAC,CAAC,EAAE;QACpB,CAAC,IAAI,EAAE,MAAM,GAAG;YAAE,MAAM,EAAE,OAAO,CAAC;YAAC,GAAG,CAAC,EAAE,OAAO,CAAC;YAAC,KAAK,CAAC,EAAE,OAAO,CAAC;YAAC,IAAI,CAAC,EAAE,OAAO,CAAC;YAAC,OAAO,CAAC,EAAE,OAAO,CAAA;SAAE,CAAA;KACvG;CACF,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,OAAO,IAAI,CAAC,GAAG;IACpD,GAAG,EAAE;QACH,SAAS,EAAE;YAAE,MAAM,EAAE,iBAAiB,CAAC;YAAC,OAAO,EAAE;gBAAE,MAAM,EAAE,yBAAyB,CAAA;aAAE,CAAA;SAAE,CAAA;QACxF,eAAe,EAAE;YAAE,MAAM,EAAE,eAAe,CAAA;SAAE,CAAA;KAC7C,CAAA;CACF,CAAA"}

package/esm/swagger-document.d.ts

@@ -0,0 +1,196 @@
+export type SwaggerDocument = {
+    openapi: string;
+    info: InfoObject;
+    jsonSchemaDialect?: string;
+    externalDocs?: ExternalDocumentationObject;
+    servers?: ServerObject[];
+    tags?: TagObject[];
+    security?: SecurityRequirementObject[];
+    paths?: Record<string, PathItem>;
+    webhooks?: Record<string, PathItem>;
+    components?: ComponentsObject;
+    [key: `x-${string}`]: unknown;
+};
+export type InfoObject = {
+    title: string;
+    version: string;
+    description?: string;
+    summary?: string;
+    termsOfService?: string;
+    contact?: ContactObject;
+    license?: LicenseObject;
+    [key: `x-${string}`]: unknown;
+};
+export type ContactObject = {
+    name?: string;
+    url?: string;
+    email?: string;
+    [key: `x-${string}`]: unknown;
+};
+export type LicenseObject = {
+    name: string;
+    identifier?: string;
+    url?: string;
+    [key: `x-${string}`]: unknown;
+};
+export type ExternalDocumentationObject = {
+    url: string;
+    description?: string;
+    [key: `x-${string}`]: unknown;
+};
+export type ServerObject = {
+    url: string;
+    description?: string;
+    variables?: Record<string, ServerVariableObject>;
+    [key: `x-${string}`]: unknown;
+};
+export type ServerVariableObject = {
+    default: string;
+    description?: string;
+    enum?: string[];
+    [key: `x-${string}`]: unknown;
+};
+export type TagObject = {
+    name: string;
+    description?: string;
+    externalDocs?: ExternalDocumentationObject;
+    [key: `x-${string}`]: unknown;
+};
+export type SecurityRequirementObject = Record<string, string[]>;
+export type ComponentsObject = {
+    schemas?: Record<string, object | boolean>;
+    responses?: Record<string, ResponseObject | ReferenceObject>;
+    parameters?: Record<string, ParameterObject | ReferenceObject>;
+    examples?: Record<string, ExampleObject | ReferenceObject>;
+    requestBodies?: Record<string, RequestBodyObject | ReferenceObject>;
+    headers?: Record<string, HeaderObject | ReferenceObject>;
+    securitySchemes?: Record<string, SecuritySchemeObject | ReferenceObject>;
+    links?: Record<string, LinkObject | ReferenceObject>;
+    callbacks?: Record<string, CallbackObject | ReferenceObject>;
+    pathItems?: Record<string, PathItem | ReferenceObject>;
+    [key: `x-${string}`]: unknown;
+};
+export type ReferenceObject = {
+    $ref: string;
+    description?: string;
+    summary?: string;
+};
+export type PathItem = {
+    summary?: string;
+    description?: string;
+    get?: Operation;
+    put?: Operation;
+    post?: Operation;
+    delete?: Operation;
+    options?: Operation;
+    head?: Operation;
+    patch?: Operation;
+    trace?: Operation;
+    servers?: ServerObject[];
+    parameters?: Array<ParameterObject | ReferenceObject>;
+    [key: `x-${string}`]: unknown;
+};
+export type Operation = {
+    tags?: string[];
+    summary?: string;
+    description?: string;
+    externalDocs?: ExternalDocumentationObject;
+    operationId?: string;
+    parameters?: Array<ParameterObject | ReferenceObject>;
+    requestBody?: RequestBodyObject | ReferenceObject;
+    responses: ResponsesObject;
+    callbacks?: Record<string, CallbackObject | ReferenceObject>;
+    deprecated?: boolean;
+    security?: SecurityRequirementObject[];
+    servers?: ServerObject[];
+    [key: `x-${string}`]: unknown;
+};
+export type ParameterObject = {
+    name: string;
+    in: 'query' | 'header' | 'path' | 'cookie';
+    description?: string;
+    required?: boolean;
+    deprecated?: boolean;
+    allowEmptyValue?: boolean;
+    style?: string;
+    explode?: boolean;
+    allowReserved?: boolean;
+    schema?: object | boolean;
+    example?: unknown;
+    examples?: Record<string, ExampleObject | ReferenceObject>;
+    content?: Record<string, MediaTypeObject>;
+    [key: `x-${string}`]: unknown;
+};
+export type RequestBodyObject = {
+    description?: string;
+    content: Record<string, MediaTypeObject>;
+    required?: boolean;
+    [key: `x-${string}`]: unknown;
+};
+export type MediaTypeObject = {
+    schema?: object | boolean;
+    example?: unknown;
+    examples?: Record<string, ExampleObject | ReferenceObject>;
+    encoding?: Record<string, EncodingObject>;
+    [key: `x-${string}`]: unknown;
+};
+export type EncodingObject = {
+    contentType?: string;
+    headers?: Record<string, HeaderObject | ReferenceObject>;
+    style?: string;
+    explode?: boolean;
+    allowReserved?: boolean;
+    [key: `x-${string}`]: unknown;
+};
+export type ResponsesObject = Record<string, ResponseObject | ReferenceObject>;
+export type ResponseObject = {
+    description: string;
+    headers?: Record<string, HeaderObject | ReferenceObject>;
+    content?: Record<string, MediaTypeObject>;
+    links?: Record<string, LinkObject | ReferenceObject>;
+    [key: `x-${string}`]: unknown;
+};
+export type HeaderObject = Omit<ParameterObject, 'name' | 'in'>;
+export type ExampleObject = {
+    summary?: string;
+    description?: string;
+    value?: unknown;
+    externalValue?: string;
+    [key: `x-${string}`]: unknown;
+};
+export type LinkObject = {
+    operationRef?: string;
+    operationId?: string;
+    parameters?: Record<string, unknown>;
+    requestBody?: unknown;
+    description?: string;
+    server?: ServerObject;
+    [key: `x-${string}`]: unknown;
+};
+export type CallbackObject = Record<string, PathItem>;
+export type SecuritySchemeObject = {
+    type: 'apiKey' | 'http' | 'mutualTLS' | 'oauth2' | 'openIdConnect';
+    description?: string;
+    name?: string;
+    in?: 'query' | 'header' | 'cookie';
+    scheme?: string;
+    bearerFormat?: string;
+    flows?: OAuthFlowsObject;
+    openIdConnectUrl?: string;
+    [key: `x-${string}`]: unknown;
+};
+export type OAuthFlowsObject = {
+    implicit?: OAuthFlowObject;
+    password?: OAuthFlowObject;
+    clientCredentials?: OAuthFlowObject;
+    authorizationCode?: OAuthFlowObject;
+    [key: `x-${string}`]: unknown;
+};
+export type OAuthFlowObject = {
+    authorizationUrl?: string;
+    tokenUrl?: string;
+    refreshUrl?: string;
+    scopes: Record<string, string>;
+    [key: `x-${string}`]: unknown;
+};
+//# sourceMappingURL=swagger-document.d.ts.map

package/esm/swagger-document.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"swagger-document.d.ts","sourceRoot":"","sources":["../src/swagger-document.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,UAAU,CAAA;IAChB,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,YAAY,CAAC,EAAE,2BAA2B,CAAA;IAC1C,OAAO,CAAC,EAAE,YAAY,EAAE,CAAA;IACxB,IAAI,CAAC,EAAE,SAAS,EAAE,CAAA;IAClB,QAAQ,CAAC,EAAE,yBAAyB,EAAE,CAAA;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IACnC,UAAU,CAAC,EAAE,gBAAgB,CAAA;IAC7B,CAAC,GAAG,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,OAAO,CAAC,EAAE,aAAa,CAAA;IACvB,OAAO,CAAC,EAAE,aAAa,CAAA;IACvB,CAAC,GAAG,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,CAAC,GAAG,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,CAAC,GAAG,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG;IACxC,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,CAAC,GAAG,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAA;IAChD,CAAC,GAAG,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,CAAC,GAAG,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,2BAA2B,CAAA;IAC1C,CAAC,GAAG,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;AAEhE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,CAAA;IAC1C,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,GAAG,eAAe,CAAC,CAAA;IAC5D,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,GAAG,eAAe,CAAC,CAAA;IAC9D,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG,eAAe,CAAC,CAAA;IAC1D,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,GAAG,eAAe,CAAC,CAAA;IACnE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,eAAe,CAAC,CAAA;IACxD,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,GAAG,eAAe,CAAC,CAAA;IACxE,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,eAAe,CAAC,CAAA;IACpD,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,GAAG,eAAe,CAAC,CAAA;IAC5D,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,GAAG,eAAe,CAAC,CAAA;IACtD,CAAC,GAAG,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,GAAG,CAAC,EAAE,SAAS,CAAA;IACf,GAAG,CAAC,EAAE,SAAS,CAAA;IACf,IAAI,CAAC,EAAE,SAAS,CAAA;IAChB,MAAM,CAAC,EAAE,SAAS,CAAA;IAClB,OAAO,CAAC,EAAE,SAAS,CAAA;IACnB,IAAI,CAAC,EAAE,SAAS,CAAA;IAChB,KAAK,CAAC,EAAE,SAAS,CAAA;IACjB,KAAK,CAAC,EAAE,SAAS,CAAA;IACjB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAA;IACxB,UAAU,CAAC,EAAE,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC,CAAA;IACrD,CAAC,GAAG,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,2BAA2B,CAAA;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC,CAAA;IACrD,WAAW,CAAC,EAAE,iBAAiB,GAAG,eAAe,CAAA;IACjD,SAAS,EAAE,eAAe,CAAA;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,GAAG,eAAe,CAAC,CAAA;IAC5D,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,QAAQ,CAAC,EAAE,yBAAyB,EAAE,CAAA;IACtC,OAAO,CAAC,EAAE,YAAY,EAAE,CAAA;IACxB,CAAC,GAAG,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAA;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACzB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG,eAAe,CAAC,CAAA;IAC1D,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;IACzC,CAAC,GAAG,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;IACxC,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,CAAC,GAAG,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACzB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG,eAAe,CAAC,CAAA;IAC1D,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IACzC,CAAC,GAAG,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,eAAe,CAAC,CAAA;IACxD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,CAAC,GAAG,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,GAAG,eAAe,CAAC,CAAA;AAE9E,MAAM,MAAM,cAAc,GAAG;IAC3B,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,eAAe,CAAC,CAAA;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;IACzC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,eAAe,CAAC,CAAA;IACpD,CAAC,GAAG,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC,CAAA;AAE/D,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,CAAC,GAAG,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpC,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,YAAY,CAAA;IACrB,CAAC,GAAG,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;AAErD,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,eAAe,CAAA;IAClE,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,EAAE,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;IAClC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,KAAK,CAAC,EAAE,gBAAgB,CAAA;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,CAAC,GAAG,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,CAAC,EAAE,eAAe,CAAA;IAC1B,QAAQ,CAAC,EAAE,eAAe,CAAA;IAC1B,iBAAiB,CAAC,EAAE,eAAe,CAAA;IACnC,iBAAiB,CAAC,EAAE,eAAe,CAAA;IACnC,CAAC,GAAG,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC9B,CAAC,GAAG,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAA;CAC9B,CAAA"}

package/esm/swagger-document.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=swagger-document.js.map

package/esm/swagger-document.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"swagger-document.js","sourceRoot":"","sources":["../src/swagger-document.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@furystack/rest",
-  "version": "8.0.22",
+  "version": "8.0.24",
   "description": "Generic REST package",
   "type": "module",
   "scripts": {
@@ -37,12 +37,12 @@
   },
   "homepage": "https://github.com/furystack/furystack",
   "dependencies": {
-    "@furystack/core": "^15.0.22",
-    "@furystack/inject": "^12.0.19"
+    "@furystack/core": "^15.0.24",
+    "@furystack/inject": "^12.0.20"
   },
   "devDependencies": {
-    "@types/node": "^24.0.3",
-    "typescript": "^5.8.3",
+    "@types/node": "^24.3.0",
+    "typescript": "^5.9.2",
     "vitest": "^3.2.4"
   },
   "gitHead": "1045d854bfd8c475b7035471d130d401417a2321"

package/src/api-endpoint-schema.ts

@@ -0,0 +1,45 @@
+import type { Method } from './methods.js'
+
+/**
+ * The JSON schema type used for API endpoint definitions.
+ */
+export type Schema = unknown // TODO: Fix me
+
+/**
+ * Represents the definition of an API endpoint, including its method, path, schema, and schema name.
+ */
+export type ApiEndpointDefinition = {
+  /**
+   * The HTTP method for the endpoint (e.g., GET, POST, PUT, DELETE).
+   */
+  method: Method
+  /**
+   * The path of the endpoint, which is the URL pattern that the endpoint responds to.
+   */
+  path: string
+  /**
+   * The JSON schema that defines the structure of the request and response for this endpoint.
+   * To include a schema, wrap your endpoint with a Validate({...}) call during the implementation.
+   */
+  schema: Schema
+  /**
+   * The name of the schema, which can be used to reference this schema in documentation or other contexts.
+   * To include a schema name, wrap your endpoint with a Validate({...}) call during the implementation.
+   */
+  schemaName: string
+  /**
+   * Indicates whether the endpoint requires authentication.
+   * To include the flag, wrap your endpoint with an Authenticat() call during the implementation.
+   */
+  isAuthenticated: boolean
+}
+
+/**
+ * Represents the schema for an API, which is a record of endpoint definitions keyed by their paths.
+ */
+export type ApiEndpointSchema = {
+  name: string
+  description: string
+  version: string
+  endpoints: Record<string, ApiEndpointDefinition>
+}

package/src/index.ts

@@ -1,6 +1,8 @@
+export * from './api-endpoint-schema.js'
 export * from './deserialize-query-string.js'
+export * from './endpoint-models/index.js'
 export * from './methods.js'
-export * from './rest-api.js'
 export * from './request-error.js'
-export * from './endpoint-models/index.js'
+export * from './rest-api.js'
 export * from './serialize-to-query-string.js'
+export * from './swagger-document.js'

package/src/rest-api.ts

@@ -1,7 +1,20 @@
+import type { ApiEndpointSchema } from './api-endpoint-schema.js'
 import type { Method } from './methods.js'
+import type { SwaggerDocument } from './swagger-document.js'
 
 export type RestApi = {
   [TMethod in Method]?: {
     [TUrl: string]: { result: unknown; url?: unknown; query?: unknown; body?: unknown; headers?: unknown }
   }
 }
+
+/**
+ * Represents an API with a GET action to retrieve its schema.
+ * This type extends the base RestApi type to include a specific GET endpoint for schema retrieval.
+ */
+export type WithSchemaAction<T extends RestApi> = T & {
+  GET: {
+    '/schema': { result: ApiEndpointSchema; headers: { accept: 'application/schema+json' } }
+    '/swagger.json': { result: SwaggerDocument }
+  }
+}