twiddlle

elastic-orm

Error

Ignore

Warn

License

Maintenance

Miscellaneous

Quality

Supply chain risk

Vulnerability

Admins only

Organization members

Dashboard

<upgradeLink>Upgrade</upgradeLink> to access this feature

About

Blog

Socket CLI

Customers

Socket Dependency Search

Docs

Socket for GitHub

Love

Impersonation Mode Active

Update your browser to the latest version for the best experience.

Your web browser is outdated

Use another browser for the best experience.

Your web browser is unsupported

{{count, number}} commits last two months

{{count, number}} critical severity alert

{{count, number}} critical severity alerts

{{count, number}} dependency vulnerability

{{count, number}} dependency vulnerabilities

{{count, number}} development dependencies

{{count, number}} transitive dependencies

{{count, number}} version published last month

{{count, number}} versions published last month

{{count, number}} version published in last two months

{{count, number}} versions published in last two months

{{count, number}} version published last week

{{count, number}} versions published last week

{{count, number}} version published last year

{{count, number}} versions published last year

Socket undergoes annual SOC2 Type II audits. Socket customers can request a copy of the full SOC2 Type II report.

Allows organization owners and admins to access detailed records of actions taken by members of their organization, complete with timestamps.

Prevent compromised packages from infiltrating your supply chain by monitoring for changes in real-time.

Join our Discord community to get help from Socket engineers and other Socket users.

Compare millions of open source packages on socket.dev

Detect malicious code and risky behavior (e.g. network) in your dependencies using "deep package inspection"

All data is encrypted in transit and at rest using industry standard encryption algorithms.

Get a dedicated Socket account manager and access to Socket’s Customer Success team.

Get dedicated support from Socket engineers via email and Slack.

"Shift left" with the Socket Chrome extension and give intervene early, before developers choose risky or low quality dependencies.

Catch developers using risky dependencies and give them a "speed bump" to encourage good behavior

Install the Socket GitHub app to receive real-time dependency scanning and reports with every pull request.

Integrate Socket into your GitHub SCM to prevent risky dependencies from being installed.

Socket scans for vulnerabilities in your dependencies, including CVEs, security advisories, and more.

Socket supports dependencies in many languages, with most popular ecosystems coming in 2024. We've got you covered no matter what languages you use.

Enforce license policies across your organization

Receive a Microsoft Teams message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Get help migrating from Socket's free plan to Socket's paid plans.

Run Socket on-premises or in your own cloud environment.

Query for any dependency (at any version) across your entire organization

Integrate Socket into your CI/CD pipeline to prevent risky dependencies from being deployed to production.

Analyze an entire project to find supply chain risks

Tag projects to organize and filter your projects

Restrict access based on the roles of individual users within an organization.

Receive a Slack message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket is SOC2 Type II compliant and undergoes annual audits.

The Socket CLI allows teams to prevent risky dependencies from being installed, and to get dependency insights from the command line.

Socket supports SAML SSO for single sign-on and identity management.

Integrate Socket into your VS Code IDE to prevent risky dependencies from being installed.

Get a POST request anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket will analyzed your SBOMs up to a maximum number of dependencies.

API that allows you to analyze a project, lookup package scores and alerts, and more.

Create API tokens to authenticate with the Socket API and CLI.

The number of developers in your team. A developer is someone who made a commit to your organization's repositories scanned by Socket in the past month.

Use Socket to protect your private repositories.

Socket is always free for open source projects.

Socket retains all reporting data for 3 months, 1 year, or a custom term of your choice.

Access the threat feed that powers Socket.

Unlimited scale, self-hosting, and priority support for large teams.

For open-source projects, individuals, and small teams.

For growing teams with enhanced scale, security, and support.

There is a package with a similar name that is downloaded much more often.

There are packages with similar names that are downloaded much more often.

This may not be the package you want!

Instance

Alert Locations

Package

The {{ecosystem}} package {{- packageName}} receives a total of <strong>{{numWeeklyDownloadCount, number}}</strong> weekly downloads. As such, {{- packageName}} popularity was classified as <strong>{{popularity}}</strong>.

Is {{- packageName}} popular?

Is {{- packageName}} safe to use?

Is {{- packageName}} well maintained?

What is {{- packageName}}?

{{packageDescription}}Version: {{versionString}} was published by {{publisherName}}. Start using Socket to analyze {{- packageName}} and its {{dependencyCount, number}} dependencies to secure your app from supply chain attacks.

Sorry, it seems this package was removed from the registry

Package was removed

This package version has been unpublished, mostly likely due to security reasons

Package version was removed

Provide a detailed description of the malware...

Socket fights vulnerabilities and provides visibility, defense-in-depth, and proactive supply chain protection for JavaScript, Python, and Go dependencies.

Socket - Secure your dependencies. Ship with confidence.

Compare versions

{{- packageName}} - npm Package Compare versions

import { EsRepositoryInterface, EsMiddlewareTypes, EsMiddlewareFunction } from './EsRepository.interface';

import { Client } from '@elastic/elasticsearch';

import { ClassType } from '../types/Class.type';

import { EsIndexInterface } from '../types/EsIndex.interface';

import { EsMappingInterface } from '../types/EsMapping.interface';

import { EsQuery } from '../query/query';

import { EsBulkResponseInterface, EsCollectionResponseInterface, EsDeleteBulkResponseInterface, EsResponseInterface } from './EsBulkResponseInterface';

import { TransportRequestOptions } from '@elastic/transport';

import { SearchRequest } from '@elastic/elasticsearch/lib/api/types';

export declare class EsRepository<Entity> implements EsRepositoryInterface<Entity> {

    private readonly registeredMiddlewares;

    constructor(Entity: ClassType<Entity>, client: Client);

    on(actionType: EsMiddlewareTypes, fn: EsMiddlewareFunction): void;

    create(entity: Entity, params?: Partial<TransportRequestOptions>): Promise<EsResponseInterface<Entity>>;

    createMultiple(entities: Entity[], params?: Partial<TransportRequestOptions>): Promise<EsBulkResponseInterface<Entity>>;

    delete(entity: Entity, params?: Partial<TransportRequestOptions>): Promise<true>;

    deleteMultiple(ids: string[], params?: Partial<TransportRequestOptions>): Promise<EsDeleteBulkResponseInterface>;

    deleteByQuery(query: EsQuery<Entity>): Promise<{

        raw: import("@elastic/elasticsearch/lib/api/types").DeleteByQueryResponse;

    find(query: EsQuery<Entity>, params?: Partial<SearchRequest>): Promise<EsCollectionResponseInterface<Entity>>;

    findById(id: string, params?: Partial<TransportRequestOptions>): Promise<EsResponseInterface<Entity>>;

    findOne(query: EsQuery<Entity>): Promise<EsResponseInterface<Entity>>;

    findOneOrFail(query: EsQuery<Entity>): Promise<EsResponseInterface<Entity>>;

    update(entity: Entity, params?: Partial<TransportRequestOptions>): Promise<EsResponseInterface<Entity>>;

    updateMultiple(entities: Entity[], params?: Partial<TransportRequestOptions>): Promise<EsBulkResponseInterface<Entity>>;

    index(entity: Entity, params?: Partial<TransportRequestOptions>): Promise<EsResponseInterface<Entity>>;

    indexMultiple(entities: Entity[], params?: Partial<TransportRequestOptions>): Promise<EsBulkResponseInterface<Entity>>;

    createIndex(indexInterface: EsIndexInterface, params?: Partial<TransportRequestOptions>): Promise<void>;

    deleteIndex(params?: Partial<TransportRequestOptions>): Promise<void>;

    updateMapping(mapping: EsMappingInterface, params?: Partial<TransportRequestOptions>): Promise<void>;

    getIndex(entity: Entity | ClassType<Entity>, query?: EsQuery): string;

import { EsBulkResponseInterface, EsCollectionResponseInterface, EsDeleteBulkResponseInterface, EsResponseDeleteByQueryInterface, EsResponseInterface } from './EsBulkResponseInterface';

export interface EsSearchParams<T, U = keyof T> {

export type EsMiddlewareTypes = 'beforeRequest';

export type EsMiddlewareFunction = (action: EsActionTypes, esParams: any, args: any[]) => void;

export interface EsRepositoryInterface<Entity> {

    create(entity: Entity): Promise<EsResponseInterface<Entity>>;

    createMultiple(entities: Entity[]): Promise<EsBulkResponseInterface<Entity>>;

    update(entity: Entity): Promise<EsResponseInterface<Entity>>;

    updateMultiple(entities: Entity[]): Promise<EsBulkResponseInterface<Entity>>;

    index(entity: Entity): Promise<EsResponseInterface<Entity>>;

    indexMultiple(entities: Entity[]): Promise<EsBulkResponseInterface<Entity>>;

    delete(entity: Entity): Promise<true>;

    deleteMultiple(ids: string[]): Promise<EsDeleteBulkResponseInterface>;

    deleteByQuery(query: EsQuery<Entity>): Promise<EsResponseDeleteByQueryInterface>;

    findOne(query: EsQuery<Entity>): Promise<EsResponseInterface<Entity | undefined>>;

    find(query: EsQuery<Entity>, params?: EsSearchParams<Entity>): Promise<EsCollectionResponseInterface<Entity>>;

    findById(id: string): Promise<EsResponseInterface<Entity>>;

    createIndex(indexInterface: EsIndexInterface): Promise<void>;

    updateMapping(mapping: EsMappingInterface): Promise<void>;

  "description": "Elasticsearch object relational mapper.",

    "build": "tsc --project ./tsconfig.json",

    "test": "jest --forceExit --detectOpenHandles \"\\.spec\\.ts\"",

    "test:full": "jest \"\\.(integration|spec|performance)\\.ts\"",

    "test:cov": "jest --collectCoverage \"\\.(integration|spec|performance)\\.ts\""

    "url": "git+https://github.com/Twiddlle/elasticsearch-orm.git"

    "url": "https://github.com/Twiddlle/elasticsearch-orm/issues"

  "homepage": "https://github.com/Twiddlle/elasticsearch-orm#readme",

    "@typescript-eslint/eslint-plugin": "^5.16.0",

    "@typescript-eslint/parser": "^5.16.0",

    "@elastic/elasticsearch": "^7.0.0 || ^8.0.0"

    "testRegex": "\\.(integration|spec|performance)\\.ts$",

![Package version](https://img.shields.io/npm/v/elastic-orm?label=version)

![Package downloads](https://img.shields.io/npm/dm/elastic-orm)

![Package types definitions](https://github.com/Twiddlle/elasticsearch-orm//actions/workflows/main.yml/badge.svg)

![Package types definitions](https://img.shields.io/github/issues-raw/Twiddlle/elasticsearch-orm)

![Top language](https://img.shields.io/github/languages/top/Twiddlle/elasticsearch-orm)

ElasticORM is an ORM tool that can run in javascript and helps developers

to define a mapping of entities in one place by using decorators.

This is the very early release of this library. New features will be added soon.

Install [package](https://www.npmjs.com/package/elastic-orm) from npm.

import { EsEntity, EsProperty, EsId } from 'elastic-orm';

@EsEntity('elastic_index') // specify elastic index

  public fingersCrossedForUkraine: boolean = true;

### 2. Client and Repository Configuration

import { EsRepository } from 'elastic-orm';

  new Client(/* client configuration */),

Client configuration is provided here [https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/7.17/client-connecting.html](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/7.17/client-connecting.html)

You can easily create index from you entity definition by running:

import { FactoryProvider } from 'elastic-orm';

  FactoryProvider.makeSchemaManager().generateIndexSchema(MyEntity);

const createdEntity = await repository.create(myEntity)

const {entities, raw} = await repository.find({

- **entities** contain deserialized entities.

- **raw** contains raw response from elastic.

- **createMultiple**: creates multiple entities

- **updateMultiple**: updates multiple entities

- **indexMultiple**: index multiple entities

- **deleteMultiple**: deletes multiple entities

- **findOne**: finds single entity by specified query

- **findOneOrFail**: finds single entity or throw exception

- **on**: registers function on specific repository actions

Repository requires specific elastic structure object by default.

Thanks to typescript query can be written really easily with autosuggestion.

		@@ -39,5 +39,5 @@ import { EsRepositoryInterface, EsMiddlewareTypes, EsMiddlewareFunction } from './EsRepository.interface';
		getEntity(): ClassType<Entity>;
		private getIndex;
		getIndex(entity: Entity \| ClassType<Entity>, query?: EsQuery): string;
		private getRefreshOption;
		private makeBulkRequest;
		}

		{
		"name": "elastic-orm",
		"version": "0.6.1",
		"version": "0.7.0",
		"description": "Elasticsearch object relational mapper.",
		@@ -5,0 +5,0 @@ "scripts": {

		@@ -12,11 +12,5 @@ # ElasticORM

		---
		NOTE

		This is the very early release of this library. New features will be added soon.

		---

		## Installation
		```shell
		Install [package](https://www.npmjs.com/package/elastic-orm) from npm.
		```bash
		npm i elastic-orm @elastic/elasticsearch
		@@ -23,0 +17,0 @@ ```

Improved metrics

Worsened metrics

		@@ -31,2 +31,3 @@ import { EsIndexInterface } from '../types/EsIndex.interface';
		getEntity(): ClassType<Entity>;
		getIndex(entity: Entity \| ClassType<Entity>, query?: EsQuery): string;
		}