@eienjs/adonisjs-api-query 1.1.1 → 3.0.0

package/build/src/types.d.ts

@@ -1,90 +0,0 @@
-import { type LucidModel, type ModelAttributes, type ModelQueryBuilderContract } from '@adonisjs/lucid/types/model';
-import { type StrictValuesWithoutRaw } from '@adonisjs/lucid/types/querybuilder';
-export interface ApiQueryConfigParameters {
-    include?: string;
-    filter?: string;
-    sort?: string;
-    fields?: string;
-    append?: string;
-}
-export interface ApiQueryConfig {
-    /**
-     * By default the package will use the `include`, `filter`, `sort`
-     * and `fields` query parameters as described in the readme.
-     *
-     * You can customize these query string parameters here.
-     */
-    parameters?: ApiQueryConfigParameters;
-    /**
-     * Related model counts are included using the relationship name suffixed with this string.
-     * For example: GET /users?include=postsCount
-     */
-    countSuffix?: string;
-    /**
-     * Related model exists are included using the relationship name suffixed with this string.
-     * For example: GET /users?include=postsExists
-     */
-    existsSuffix?: string;
-    /**
-     * By default the package will throw an `InvalidFilterQuery` exception when a filter in the
-     * URL is not allowed in the `allowedFilters()` method.
-     */
-    disableInvalidFilterQueryException?: boolean;
-    /**
-     * By default the package will throw an `InvalidSortQuery` exception when a sort in the
-     * URL is not allowed in the `allowedSorts()` method.
-     */
-    disableInvalidSortQueryException?: boolean;
-    /**
-     * By default the package will throw an `InvalidIncludeQuery` exception when an include in the
-     * URL is not allowed in the `allowedIncludes()` method.
-     */
-    disableInvalidIncludesQueryException?: boolean;
-    /**
-     * By default, the package expects relationship names to be camel case plural when using fields[relationship].
-     * For example, fetching the id and name for a userOwner relation would look like this:
-     * GET /users?fields[userOwner]=id,name
-     *
-     * Set this to `true` if you don't want that and keep the requested relationship names as-is and allows you to
-     * request the fields using a snake case relationship name:
-     * GET /users?fields[user_owner]=id,name
-     */
-    convertRelationNamesToSnakeCasePlural?: boolean;
-    /**
-     * By default, the package expects relationship names to be camel case plural when using fields[relationship].
-     * For example, fetching the id and name for a userOwner relation would look like this:
-     * GET /users?fields[userOwner]=id,name
-     *
-     * Set this to one of `snake_case`, `camelCase` or `none` if you want to enable table name resolution in addition to the relation name resolution
-     * GET /users?include=top_orders&fields[orders]=id,name
-     */
-    convertRelationTableNameStrategy?: 'snake_case' | 'camelCase' | 'none' | false;
-    /**
-     * By default, the package expects the field names to match the database names
-     * For example, fetching the field named firstName would look like this:
-     * GET /users?fields=firstName
-     *
-     * Set this to `true` if you want to convert the firstName into first_name for the underlying query
-     */
-    convertFieldNamesToSnakeCase?: boolean;
-}
-export type ResolvedApiQueryConfig = Required<ApiQueryConfig> & {
-    parameters: Required<ApiQueryConfigParameters>;
-};
-export interface Sort<Model extends LucidModel> {
-    handle(query: ModelQueryBuilderContract<Model, InstanceType<Model>>, descending: boolean, property: string): void;
-}
-export interface Filter<Model extends LucidModel> {
-    handle(query: ModelQueryBuilderContract<Model, InstanceType<Model>>, value: StrictValuesWithoutRaw | null, property: string): void;
-}
-export interface Include<ParentModel extends LucidModel> {
-    handle(query: ModelQueryBuilderContract<ParentModel, InstanceType<ParentModel>>, include: string): void;
-}
-export type ExtractKeys<T> = T extends object ? {
-    [K in keyof T & string]: K;
-}[keyof T & string] : never;
-export type ExtractKeysWithSort<T> = T extends object ? {
-    [K in keyof T & string]: `-${K}`;
-}[keyof T & string] : never;
-export type SortUnionKeyParams<Model extends LucidModel> = ExtractKeys<ModelAttributes<InstanceType<Model>>> | ExtractKeysWithSort<ModelAttributes<InstanceType<Model>>>;
-export type HintedString<KnownValues> = KnownValues extends string ? (string & {}) | KnownValues : never;

package/build/src/types.js

@@ -1 +0,0 @@
-//# sourceMappingURL=types.js.map

package/build/src/types.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/build/src/utils/helpers.d.ts

@@ -1,3 +0,0 @@
-export declare const substrReplace: (str: string, replace: string, start: number, length?: number) => string;
-export declare const strBeforeLast: (subject: string, search: string) => string;
-export declare const strAfterLast: (subject: string, search: string) => string;