lumen-framework 3.1.0 → 4.0.0

package/dist/types/packages/router/route/params/parameter/ignored-parameter.d.ts

@@ -0,0 +1,14 @@
+import Parameter from './index';
+/**
+ * A member the resource has but the controller does not accept (e.g. a
+ * read-only `createdAt`). It is dropped from the validated params instead of
+ * being rejected, so clients that send whole resources back — ember-data
+ * serializes every attribute — keep working. A member the resource does not
+ * have at all is still a 400. See nickschot/lux#47.
+ *
+ * @internal
+ */
+declare class IgnoredParameter extends Parameter {
+    constructor(path: string);
+}
+export default IgnoredParameter;

package/dist/types/packages/router/route/params/parameter/index.d.ts

@@ -1,8 +1,7 @@
 import { FreezeableSet } from '../../../../freezeable';
-import type { Parameter$opts } from './interfaces';
-/**
- * @private
- */
+import type { ParameterOptions } from './interfaces';
+import type { ParameterLike } from '../interfaces';
+/** @internal */
 declare class Parameter extends FreezeableSet<unknown> {
     path: string;
     type: string;
@@ -16,7 +15,24 @@ declare class Parameter extends FreezeableSet<unknown> {
      * serializer without relationships, where JSON:API requires a 400.)
      */
     restricted: boolean;
-    constructor({ path, type, values, required, sanitize }: Parameter$opts);
+    /**
+     * Inclusive bounds of a `number` parameter, when given.
+     */
+    min?: number;
+    max?: number;
+    /**
+     * Converts a value as the client sent it into the parameter's type before
+     * it is validated (e.g. a JSON:API string id into a numeric primary key),
+     * when given. Values it does not recognize are returned as is, and so fail
+     * validation.
+     */
+    parse?: (value: unknown) => unknown;
+    /**
+     * For an `array` parameter, builds the parameter each element is validated
+     * with, given the element's path (`data.relationships.tags.data.0`).
+     */
+    items?: (path: string) => ParameterLike;
+    constructor({ path, type, values, min, max, parse, items, required, sanitize }: ParameterOptions);
     validate<V>(value: V): V;
 }
 export default Parameter;

package/dist/types/packages/router/route/params/parameter/interfaces.d.ts

@@ -1,4 +1,4 @@
-import type { ParameterLike$opts } from '../index';
-export type Parameter$opts = ParameterLike$opts & {
+import type { ParameterLikeOptions } from '../index';
+export type ParameterOptions = ParameterLikeOptions & {
     values?: Array<unknown>;
 };

package/dist/types/packages/router/route/params/parameter/utils/validate-range.d.ts

@@ -0,0 +1,3 @@
+import type Parameter from '../index';
+/** @internal */
+export default function validateRange(param: Parameter, value: unknown): true;

package/dist/types/packages/router/route/params/parameter/utils/validate-value.d.ts

@@ -1,5 +1,3 @@
 import type Parameter from '../index';
-/**
- * @private
- */
+/** @internal */
 export default function validateValue<V>(param: Parameter, value: V): V;

package/dist/types/packages/router/route/params/parameter-group/index.d.ts

@@ -1,14 +1,12 @@
 import { FreezeableMap } from '../../../../freezeable';
-import type { ParameterLike, ParameterLike$opts } from '../index';
-/**
- * @private
- */
+import type { ParameterLike, ParameterLikeOptions } from '../index';
+/** @internal */
 declare class ParameterGroup extends FreezeableMap<string, ParameterLike> {
     type: string;
     path: string;
     required: boolean;
     sanitize: boolean;
-    constructor(contents: Array<[string, ParameterLike]>, { path, required, sanitize }: ParameterLike$opts);
+    constructor(contents: Array<[string, ParameterLike]>, { path, required, sanitize }: ParameterLikeOptions);
     validate<V>(params: V): V;
 }
 export default ParameterGroup;

package/dist/types/packages/router/route/params/parameter-group/utils/missing-params.d.ts

@@ -0,0 +1,8 @@
+import type { ServerError } from '../../../../../server';
+import type ParameterGroup from '../index';
+/**
+ * An error for each required member of `group` that `params` lacks.
+ *
+ * @internal
+ */
+export default function missingParams(group: ParameterGroup, params: Record<string, unknown>): Array<ServerError>;

package/dist/types/packages/router/route/params/utils/get-data-params.d.ts

@@ -1,6 +1,10 @@
 import type Controller from '../../../../controller';
 import type { ParameterLike } from '../interfaces';
 /**
- * @private
+ * The top level members of a request document besides `data`.
+ *
+ * @internal
  */
+export declare function getDocumentParams(): Array<[string, ParameterLike]>;
+/** @internal */
 export default function getDataParams(controller: Controller, method: 'PATCH' | 'POST', includeID: boolean): [string, ParameterLike];

package/dist/types/packages/router/route/params/utils/get-default-collection-params.d.ts

@@ -1,6 +1,4 @@
 import type Controller from '../../../../controller';
-/**
- * @private
- */
+/** @internal */
 declare function getDefaultCollectionParams(controller: Controller): Record<string, unknown>;
 export default getDefaultCollectionParams;

package/dist/types/packages/router/route/params/utils/get-default-member-params.d.ts

@@ -1,5 +1,8 @@
 import type Controller from '../../../../controller';
 /**
- * @private
+ * Without a fieldset, primary data loads every attribute its Serializer
+ * declares. Other types need no default: an absent fieldset means all fields.
+ *
+ * @internal
  */
-export default function getDefaultMemberParams({ model, serializer: { hasOne, hasMany, attributes } }: Controller): Record<string, unknown>;
+export default function getDefaultMemberParams({ model, serializer: { attributes } }: Controller): Record<string, unknown>;

package/dist/types/packages/router/route/params/utils/get-query-params.d.ts

@@ -1,14 +1,8 @@
 import type Controller from '../../../../controller';
 import type { ParameterLike } from '../interfaces';
-/**
- * @private
- */
+/** @internal */
 export declare function getCustomParams({ query }: Controller): Array<[string, ParameterLike]>;
-/**
- * @private
- */
+/** @internal */
 export declare function getMemberQueryParams(controller: Controller): Array<[string, ParameterLike]>;
-/**
- * @private
- */
+/** @internal */
 export declare function getCollectionQueryParams(controller: Controller): Array<[string, ParameterLike]>;

package/dist/types/packages/router/route/params/utils/get-url-params.d.ts

@@ -1,5 +1,3 @@
 import type { ParameterLike } from '../interfaces';
-/**
- * @private
- */
+/** @internal */
 export default function getURLParams(dynamicSegments: Array<string>): Array<[string, ParameterLike]>;

package/dist/types/packages/router/route/params/utils/parse-column-value.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Parse an id from a request document. JSON:API ids are strings, so a numeric
+ * primary key takes the number a string of digits spells; anything else is
+ * returned as is (a number still passes, for lenient clients).
+ *
+ * @internal
+ */
+export declare function parseId(type: string | undefined): (value: unknown) => unknown;
+/**
+ * The parser for attribute values written to a column of `type`, if it needs
+ * one. JSON has no dates, so a date column takes an ISO 8601 string; every
+ * other value is typed by JSON already and is validated as sent.
+ *
+ * @internal
+ */
+export declare function parserFor(type: string | undefined): ((value: unknown) => unknown) | undefined;

package/dist/types/packages/router/route/params/utils/validate-client-id.d.ts

@@ -3,6 +3,6 @@
  * is answered with 403 (unsupported client-generated ID) rather than the 400
  * an unknown member gets.
  *
- * @private
+ * @internal
  */
 export default function validateClientId(params: Record<string, unknown>): boolean;

package/dist/types/packages/router/route/params/utils/validate-resource-id.d.ts

@@ -1,5 +1,3 @@
 import type { Request } from '../../../../server';
-/**
- * @private
- */
+/** @internal */
 export default function validateResourceId({ params: { id, data: { id: resourceId } } }: Request): true;

package/dist/types/packages/router/route/params/utils/validate-type.d.ts

@@ -1,5 +1,3 @@
-import type { Parameter, ParameterGroup } from '../index';
-/**
- * @private
- */
-export default function validateType(param: Parameter | ParameterGroup, value: unknown): true;
+import type { ParameterLike } from '../index';
+/** @internal */
+export default function validateType(param: ParameterLike, value: unknown): true;

package/dist/types/packages/router/route/utils/get-dynamic-segments.d.ts

@@ -1,4 +1,2 @@
-/**
- * @private
- */
+/** @internal */
 export default function getDynamicSegments(path: string): Array<string>;

package/dist/types/packages/router/route/utils/get-static-path.d.ts

@@ -1,4 +1,8 @@
 /**
- * @private
+ * The route key path of `path`: each dynamic segment (`:id`) becomes
+ * `:dynamic`, the form `Router#resolve()` turns request paths into. Only whole
+ * segments are replaced — `/videos/:id` is `/videos/:dynamic`.
+ *
+ * @internal
  */
-export default function getStaticPath(path: string, dynamicSegments: Array<string>): string;
+export default function getStaticPath(path: string): string;

package/dist/types/packages/router/utils/create-replacer.d.ts

@@ -1,5 +1,13 @@
 import type Controller from '../../controller';
+export type Replacer = (pathname: string) => {
+    staticPath: string;
+    params: Array<string>;
+};
 /**
- * @private
+ * Build the function that finds the ids in a request path: the segment after
+ * a resource name. An id must be an integer unless the resource's primary key
+ * is not numeric (e.g. a uuid), in which case any segment is one.
+ *
+ * @internal
  */
-export default function createReplacer(controllers: Map<string, Controller>): RegExp;
+export default function createReplacer(controllers: Map<string, Controller>): Replacer;