@dalencatt/strapi-plugin-fuzzy-search-private 0.0.0-development

package/dist/server/src/config/query.schema.d.ts

@@ -0,0 +1,34 @@
+import { InferType } from 'yup';
+export declare const paginationSchema: import("yup").ObjectSchema<{
+    pageSize: string;
+    page: string;
+    withCount: string;
+}, import("yup").AnyObject, {
+    pageSize: undefined;
+    page: undefined;
+    withCount: undefined;
+}, "">;
+export declare const populationSchema: import("yup").StringSchema<string, import("yup").AnyObject, undefined, "">;
+export declare const querySchema: import("yup").ObjectSchema<{
+    query: string;
+    locale: string;
+    filters: {
+        contentTypes?: string;
+    };
+}, import("yup").AnyObject, {
+    query: undefined;
+    locale: undefined;
+    filters: {
+        contentTypes: undefined;
+    };
+}, "">;
+export type PaginationBaseQuery = InferType<typeof paginationSchema>;
+export type PopulationSchema = InferType<typeof populationSchema>;
+type QuerySchema = InferType<typeof querySchema>;
+export type SearchQuery = Omit<QuerySchema, 'filters'> & {
+    pagination?: Record<string, PaginationBaseQuery>;
+    populate?: Record<string, PopulationSchema>;
+    filters?: QuerySchema['filters'] & Record<string, any>;
+    status?: 'published' | 'draft';
+};
+export {};

package/dist/server/src/controllers/index.d.ts

@@ -0,0 +1,8 @@
+declare const _default: {
+    searchController: () => {
+        search(ctx: import("../interfaces/interfaces").Context): Promise<void | {
+            [x: string]: Record<string, unknown>[] | import("../interfaces/interfaces").PaginatedModelResponse<import("../interfaces/interfaces").RESTPaginationMeta>;
+        }>;
+    };
+};
+export default _default;

package/dist/server/src/controllers/search-controller.d.ts

@@ -0,0 +1,7 @@
+import { Context } from '../interfaces/interfaces';
+declare const _default: () => {
+    search(ctx: Context): Promise<void | {
+        [x: string]: Record<string, unknown>[] | import("../interfaces/interfaces").PaginatedModelResponse<import("../interfaces/interfaces").RESTPaginationMeta>;
+    }>;
+};
+export default _default;

package/dist/server/src/graphql/index.d.ts

@@ -0,0 +1,3 @@
+import { Core } from '@strapi/strapi';
+declare const registerGraphlQLQuery: (strapi: Core.Strapi) => void;
+export default registerGraphlQLQuery;

package/dist/server/src/graphql/resolvers-config.d.ts

@@ -0,0 +1,8 @@
+declare const getResolversConfig: () => {
+    'Query.search': {
+        auth: {
+            scope: string;
+        };
+    };
+};
+export default getResolversConfig;

package/dist/server/src/graphql/types.d.ts

@@ -0,0 +1,3 @@
+import { Core } from '@strapi/strapi';
+declare const getCustomTypes: (strapi: Core.Strapi, nexus: any) => any[];
+export default getCustomTypes;

package/dist/server/src/index.d.ts

@@ -0,0 +1,33 @@
+declare const _default: {
+    bootstrap: () => void;
+    register: ({ strapi }: {
+        strapi: import("@strapi/types/dist/core").Strapi;
+    }) => void;
+    config: {
+        default(): {
+            contentTypes: {};
+        };
+        validator(config: import("./interfaces/interfaces").Config): Promise<void>;
+    };
+    controllers: {
+        searchController: () => {
+            search(ctx: import("./interfaces/interfaces").Context): Promise<void | {
+                [x: string]: Record<string, unknown>[] | import("./interfaces/interfaces").PaginatedModelResponse<import("./interfaces/interfaces").RESTPaginationMeta>;
+            }>;
+        };
+    };
+    routes: {
+        'content-api': {
+            type: string;
+            routes: {
+                method: string;
+                path: string;
+                handler: string;
+            }[];
+        };
+    };
+    services: {
+        settingsService: () => import("./services/settings-service").SettingsService;
+    };
+};
+export default _default;

package/dist/server/src/interfaces/interfaces.d.ts

@@ -0,0 +1,98 @@
+import { Schema } from '@strapi/strapi';
+import { SearchQuery } from '../config/query.schema';
+export type Mutable<T> = {
+    -readonly [P in keyof T]: T[P];
+};
+export interface Config {
+    contentTypes: ContentType[];
+}
+export interface FuzzySortOptions {
+    threshold?: number;
+    limit?: number;
+    characterLimit?: number;
+    keys: {
+        name: string;
+        weight?: number;
+    }[];
+}
+export interface ContentType extends Schema.ContentType {
+    transliterate?: boolean;
+    fuzzysortOptions: FuzzySortOptions;
+}
+export interface QueryResult extends ContentType {
+    entries: Entry[];
+}
+export interface Result {
+    fuzzysortResults: Fuzzysort.KeysResults<Entry>;
+    schema: Schema.ContentType;
+}
+export interface Entry {
+    id: string | number;
+    [x: string]: any;
+}
+export interface PaginationMeta {
+    start: number;
+    limit: number;
+}
+export interface RESTPaginationMeta {
+    pagination: {
+        page: number;
+        pageSize: number;
+        pageCount?: number;
+        total?: number;
+    };
+}
+export interface PaginatedModelResponse<Meta = PaginationMeta> {
+    meta: Meta;
+    data: unknown[];
+}
+export type ResultsResponse = Record<string, Record<string, unknown>[]>;
+export type PaginatedResultsResponse<Meta = PaginationMeta> = Record<string, PaginatedModelResponse<Meta>>;
+export interface SearchResponseArgs {
+    query: string;
+    locale?: string;
+}
+export type SearchResponseReturnType = SearchResponseArgs & {
+    auth: Record<string, unknown>;
+};
+export type PaginationParams = Record<string, {
+    pageSize?: string;
+    page?: string;
+    withCount?: string;
+}>;
+export interface PaginationArgs {
+    page?: number;
+    pageSize?: number;
+    limit?: number;
+    start?: number;
+}
+export interface TransformedPagination {
+    limit: number;
+    start: number;
+}
+export interface Context {
+    state: {
+        auth: unknown;
+    };
+    query: SearchQuery;
+    badRequest: (prefix: string, message: string) => void;
+}
+export interface Attribute {
+    type: string;
+    writable?: boolean;
+    relation?: string;
+    [key: string]: unknown;
+}
+export interface Model {
+    uid?: string;
+    kind: 'singleType' | 'collectionType';
+    info: {
+        singularName: string;
+        pluralName: string;
+    };
+    options: {
+        populateCreatorFields: boolean;
+    };
+    privateAttributes?: string[];
+    attributes: Record<string, Attribute>;
+}

package/dist/server/src/register.d.ts

@@ -0,0 +1,5 @@
+import { Core } from '@strapi/strapi';
+declare const _default: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => void;
+export default _default;

package/dist/server/src/routes/index.d.ts

@@ -0,0 +1,11 @@
+declare const _default: {
+    'content-api': {
+        type: string;
+        routes: {
+            method: string;
+            path: string;
+            handler: string;
+        }[];
+    };
+};
+export default _default;

package/dist/server/src/routes/search-routes.d.ts

@@ -0,0 +1,6 @@
+declare const _default: {
+    method: string;
+    path: string;
+    handler: string;
+}[];
+export default _default;

package/dist/server/src/services/fuzzySearch-service.d.ts

@@ -0,0 +1,23 @@
+import { WhereQuery } from '@strapi/utils/dist/convert-query-params';
+import { ContentType, Entry, FuzzySortOptions, Result } from '../interfaces/interfaces';
+export declare const buildResult: ({ entries, fuzzysortOptions, keys, query, }: {
+    entries: Entry[];
+    fuzzysortOptions: FuzzySortOptions;
+    keys: string[];
+    query: string;
+}) => Fuzzysort.KeysResults<Entry>;
+export declare const buildTransliteratedResult: ({ entries, fuzzysortOptions, keys, query, result, }: {
+    entries: Entry[];
+    fuzzysortOptions: FuzzySortOptions;
+    keys: string[];
+    query: string;
+    result: Fuzzysort.KeysResults<Entry>;
+}) => Fuzzysort.KeysResults<Entry>;
+export default function getResult({ contentType, query, filters, populate, locale, status, }: {
+    contentType: ContentType;
+    query: string;
+    filters?: WhereQuery;
+    populate?: string;
+    locale?: string;
+    status?: 'published' | 'draft';
+}): Promise<Result>;

package/dist/server/src/services/index.d.ts

@@ -0,0 +1,4 @@
+declare const _default: {
+    settingsService: () => import("./settings-service").SettingsService;
+};
+export default _default;

package/dist/server/src/services/pagination-service.d.ts

@@ -0,0 +1,9 @@
+import { PaginationBaseQuery } from '../config/query.schema';
+import { PaginatedModelResponse, RESTPaginationMeta, ResultsResponse } from '../interfaces/interfaces';
+export declare const paginateRestResults: (pagination: Record<string, PaginationBaseQuery>, pluralNames: string[], resultsResponse: ResultsResponse) => Promise<{
+    [x: string]: Record<string, unknown>[] | PaginatedModelResponse<RESTPaginationMeta>;
+}>;
+export declare const paginateGraphQlResults: (results: unknown[], { limit, start }: {
+    limit: number;
+    start: number;
+}) => PaginatedModelResponse;

package/dist/server/src/services/response-transformation-service.d.ts

@@ -0,0 +1,7 @@
+import { PaginationBaseQuery } from '../config/query.schema';
+import { ContentType, Entry, Result, TransformedPagination } from '../interfaces/interfaces';
+export declare const buildGraphqlResponse: (searchResult: Fuzzysort.KeysResults<Entry>, schema: ContentType, auth: Record<string, unknown>, pagination: TransformedPagination) => Promise<any>;
+export declare const buildRestResponse: (searchResults: Result[], auth: unknown, pagination?: Record<string, PaginationBaseQuery>, queriedContentTypes?: string[]) => Promise<{
+    [x: string]: Record<string, unknown>[] | import("../interfaces/interfaces").PaginatedModelResponse<import("../interfaces/interfaces").RESTPaginationMeta>;
+}>;
+export default buildRestResponse;

package/dist/server/src/services/settings-service.d.ts

@@ -0,0 +1,8 @@
+import { Config } from '../interfaces/interfaces';
+export interface SettingsService {
+    get(): Config;
+    set(settings: Config): unknown;
+    build(settings: Config): Config;
+}
+declare const settingsService: () => SettingsService;
+export default settingsService;

package/dist/server/src/services/validation-service.d.ts

@@ -0,0 +1,4 @@
+import { PopulationSchema, SearchQuery } from '../config/query.schema';
+import { ContentType, PaginationParams } from '../interfaces/interfaces';
+export declare const validateQueryParams: (query: SearchQuery, contentTypes: ContentType[], pagination: PaginationParams | undefined, populate: Record<string, PopulationSchema> | undefined, filteredContentTypes: string[] | null | undefined) => Promise<void>;
+export declare const validateQuery: (contentType: ContentType, locale?: string) => Promise<void>;

package/dist/server/src/utils/pluginId.d.ts

@@ -0,0 +1,2 @@
+declare const _default: string;
+export default _default;

package/package.json

@@ -0,0 +1,114 @@
+{
+  "name": "@dalencatt/strapi-plugin-fuzzy-search-private",
+  "version": "0.0.0-development",
+  "description": "Register a weighted fuzzy search endpoint for Strapi Headless CMS you can add your content types to in no time.",
+  "strapi": {
+    "displayName": "Fuzzy Search",
+    "name": "fuzzy-search",
+    "description": "Register a weighted fuzzy search endpoint to your content types in no time.",
+    "kind": "plugin"
+  },
+  "type": "commonjs",
+  "exports": {
+    "./package.json": "./package.json",
+    "./strapi-server": {
+      "types": "./dist/server/src/index.d.ts",
+      "source": "./server/src/index.ts",
+      "import": "./dist/server/index.mjs",
+      "require": "./dist/server/index.js",
+      "default": "./dist/server/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "semantic-release": "semantic-release",
+    "build": "strapi-plugin build",
+    "watch": "strapi-plugin watch",
+    "watch:link": "strapi-plugin watch:link",
+    "verify": "strapi-plugin verify",
+    "test:ts:back": "run -T tsc -p server/tsconfig.json",
+    "typecheck": "tsc --noEmit -p server/tsconfig.json",
+    "test": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "test:coverage:json": "vitest run --coverage.enabled --coverage.reporter=json-summary",
+    "lint": "eslint .",
+    "prettier:check": "prettier --check ./server ./tests",
+    "prettier:write": "prettier --write ./server ./tests"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "tag": "latest"
+  },
+  "release": {
+    "branches": [
+      "main",
+      {
+        "name": "beta",
+        "prerelease": true
+      },
+      {
+        "name": "beta-private",
+        "prerelease": true
+      }
+    ]
+  },
+  "dependencies": {
+    "fuzzysort": "3.1.0",
+    "transliteration": "2.3.5"
+  },
+  "peerDependencies": {
+    "@strapi/sdk-plugin": "^5.2.7",
+    "@strapi/strapi": "^5.1.1",
+    "@strapi/utils": "^5.1.1",
+    "yup": "1.4.0"
+  },
+  "devDependencies": {
+    "@eslint/compat": "^1.2.2",
+    "@eslint/eslintrc": "^3.1.0",
+    "@eslint/js": "^9.13.0",
+    "@strapi/sdk-plugin": "^5.2.7",
+    "@strapi/strapi": "^5.1.1",
+    "@strapi/typescript-utils": "^5.1.1",
+    "@typescript-eslint/eslint-plugin": "8.12.1",
+    "@typescript-eslint/parser": "8.12.1",
+    "@vitest/coverage-v8": "2.1.4",
+    "all-contributors-cli": "^6.20.0",
+    "eslint": "^9.13.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-import": "2.31.0",
+    "eslint-plugin-prettier": "5.2.1",
+    "eslint-plugin-promise": "7.1.0",
+    "globals": "^15.11.0",
+    "prettier": "3.3.3",
+    "semantic-release": "^24.0.0",
+    "typescript": "^5.6.3",
+    "typescript-eslint": "^8.12.1",
+    "vitest": "2.1.4"
+  },
+  "author": "@DomDew (https://github.com/DomDew)",
+  "maintainers": [
+    "@DomDew (https://github.com/DomDew)",
+    "@wfproductions (https://github.com/wfproductions)"
+  ],
+  "engines": {
+    "node": ">=18.x.x <=20.x.x",
+    "npm": ">=6.0.0"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Moonlight63/strapi-plugin-fuzzy-search.git"
+  },
+  "keywords": [
+    "strapi",
+    "fuzzysort",
+    "fuzzysearch",
+    "search"
+  ],
+  "bugs": {
+    "url": "https://github.com/DomDew/strapi-plugin-fuzzy-search/issues"
+  },
+  "homepage": "https://github.com/DomDew/strapi-plugin-fuzzy-search#readme"
+}