Skip to content

Commit

Permalink
chore: replaces @askorama handle with @oramasearch (#846)
Browse files Browse the repository at this point in the history
  • Loading branch information
micheleriva authored Nov 22, 2024
1 parent 1d25adb commit 9051b71
Show file tree
Hide file tree
Showing 50 changed files with 91 additions and 91 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<p align="center">
<img src="https://raw.githubusercontent.com/askorama/orama/refs/heads/main/misc/readme/orama-readme-hero-dark.png#gh-dark-mode-only" />
<img src="https://raw.githubusercontent.com/askorama/orama/refs/heads/main/misc/readme/orama-readme-hero-light.png#gh-light-mode-only" />
<img src="https://raw.githubusercontent.com/oramasearch/orama/refs/heads/main/misc/readme/orama-readme-hero-dark.png#gh-dark-mode-only" />
<img src="https://raw.githubusercontent.com/oramasearch/orama/refs/heads/main/misc/readme/orama-readme-hero-light.png#gh-light-mode-only" />
</p>

[![Tests](https://github.com/oramasearch/orama/actions/workflows/turbo.yml/badge.svg)](https://github.com/oramasearch/orama/actions/workflows/turbo.yml)
Expand Down Expand Up @@ -54,8 +54,8 @@ Read the complete documentation at [https://docs.orama.com](https://docs.orama.c
# Orama Features

<p align="center">
<img src="https://raw.githubusercontent.com/askorama/orama/refs/heads/main/misc/readme/features-dark.png#gh-dark-mode-only" />
<img src="https://raw.githubusercontent.com/askorama/orama/refs/heads/main/misc/readme/features-light.png#gh-light-mode-only" />
<img src="https://raw.githubusercontent.com/oramasearch/orama/refs/heads/main/misc/readme/features-dark.png#gh-dark-mode-only" />
<img src="https://raw.githubusercontent.com/oramasearch/orama/refs/heads/main/misc/readme/features-light.png#gh-light-mode-only" />
</p>

# Usage
Expand Down
6 changes: 3 additions & 3 deletions packages/docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ export default defineConfig({
favicon: '/favicon.png',
head: head,
social: {
github: 'https://github.com/askorama/orama',
github: 'https://github.com/oramasearch/orama',
slack: 'https://orama.to/slack',
twitter: 'https://x.com/askorama',
twitter: 'https://x.com/oramasearch',
},
customCss: ['./src/tailwind.css', './src/styles/custom.css'],
logo: {
Expand All @@ -58,7 +58,7 @@ export default defineConfig({
...openSourceMenu,
],
editLink: {
baseUrl: 'https://github.com/askorama/orama/edit/main/packages/docs'
baseUrl: 'https://github.com/oramasearch/orama/edit/main/packages/docs'
}
}),
react(),
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/config/menu/orama-cloud.ts
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ const oramaCloudMenu = [
},
{
label: 'Github repository',
link: 'https://github.com/askorama/orama'
link: 'https://github.com/oramasearch/orama'
}
]
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ Some features may not be available in all SDKs yet.

| Package | Search Engine | Answer Engine | Index Manager |
|----------------------------------------------------------------------|---------------------|--------------------|---------------------|
| [Client JavaScript](https://github.com/askorama/oramacloud-client) | <center>✅</center> | <center>✅</center> | <center>✅</center> |
| [Client PHP](https://github.com/askorama/oramacloud-client-php) | <center>✅</center> | <center>🚧</center> | <center>✅</center> |
| [Client Swift](https://github.com/askorama/oramacloud-client-swift) | <center>✅</center> | <center>🚧</center> | <center>🚧</center> |
| [Client Kotlin](https://github.com/askorama/oramacloud-client-kotlin)| <center>✅</center> | <center>✅</center> | <center>✅</center> |
| [Client JavaScript](https://github.com/oramasearch/oramacloud-client) | <center>✅</center> | <center>✅</center> | <center>✅</center> |
| [Client PHP](https://github.com/oramasearch/oramacloud-client-php) | <center>✅</center> | <center>🚧</center> | <center>✅</center> |
| [Client Swift](https://github.com/oramasearch/oramacloud-client-swift) | <center>✅</center> | <center>🚧</center> | <center>🚧</center> |
| [Client Kotlin](https://github.com/oramasearch/oramacloud-client-kotlin)| <center>✅</center> | <center>✅</center> | <center>✅</center> |
| Client Python (Coming soon) | <center>🚧</center> | <center>🚧</center> | <center>🚧</center> |

Do you want to see a specific language supported? [Let us know](https://github.com/orgs/askorama/discussions/new?category=ideas)!
Do you want to see a specific language supported? [Let us know](https://github.com/orgs/oramasearch/discussions/new?category=ideas)!

---

Expand Down Expand Up @@ -75,7 +75,7 @@ Alternatively, you can use the Swift Package Manager by adding the following lin
```swift
dependencies: [
.package(url: "https://github.com/askorama/oramacloud-client-swift.git", from: "0.0.1")
.package(url: "https://github.com/oramasearch/oramacloud-client-swift.git", from: "0.0.1")
]
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -942,7 +942,7 @@ Orama currently supports the following units of measurement:
- `yd` (yards)
- `mi` (miles)
All these units will be converted into meters automatically. If you feel like we should support other units of measurement, please [open an issue](https://github.com/askorama/orama/issues)
All these units will be converted into meters automatically. If you feel like we should support other units of measurement, please [open an issue](https://github.com/oramasearch/orama/issues)
### Filtering by bounding polygon
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/content/docs/cloud/whats-new.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ next: false
import { Aside } from '@astrojs/starlight/components';

This page features the release history of <a href="https://cloud.orama.com" target="_blank">Orama Cloud</a>.
If you are looking for Orama Open Source release history, you can find it <a href="https://github.com/askorama/orama/releases" target="_blank">here</a>.
If you are looking for Orama Open Source release history, you can find it <a href="https://github.com/oramasearch/orama/releases" target="_blank">here</a>.

We continously release new features and new integrations, check them out!

Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ import { Card, CardGrid, LinkCard } from '@astrojs/starlight/components';
Import your data in just a few clicks by uploading a [static file](/cloud/data-sources/static-files/) or using our [web crawler](/cloud/data-sources/other-sources/web-crawler) to scrape your website.
</Card>
<Card title="Open Source" icon="github">
Check out the [Open Source documentation](/open-source) and visit our [GitHub repository](https://github.com/askorama/orama). Don't forget to star us! ⭐️
Check out the [Open Source documentation](/open-source) and visit our [GitHub repository](https://github.com/oramasearch/orama). Don't forget to star us! ⭐️
</Card>
</CardGrid>
</div>
Expand Down
4 changes: 2 additions & 2 deletions packages/docs/src/content/docs/open-source/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ import { Code } from '@astrojs/starlight/components'
import { ShowcaseCTA } from 'starlight-showcases'

<ShowcaseCTA title="Are you looking for Orama Cloud?">
This is the documentation for Orama's **Open Source** products. Please consider starring our repo on [GitHub](https://github.com/askorama/orama) and supporting our project. If you're looking for **Orama Cloud**, [click here](/cloud).
This is the documentation for Orama's **Open Source** products. Please consider starring our repo on [GitHub](https://github.com/oramasearch/orama) and supporting our project. If you're looking for **Orama Cloud**, [click here](/cloud).
</ShowcaseCTA>

<br />

Orama is an <a href="https://github.com/AskOrama/orama" target="_blank">open source</a>, high performance full-text and vector search engine entirely written in TypeScript, with zero dependencies.
Orama is an <a href="https://github.com/oramasearch/orama" target="_blank">open source</a>, high performance full-text and vector search engine entirely written in TypeScript, with zero dependencies.

## Requirements

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ As for `v2.0.0`, Orama introduces the concept of **Plugins** in the core of the

That said, the Orama core team is working on some official plugins to support specific features that might be useful for the general public. That way, you will be able to bring in only the features you really need.

All the official plugins' source code is hosted under the [Orama](https://github.com/askorama/orama) monorepo, in the [`packages`](https://github.com/askorama/orama/tree/main/packages) directory.
All the official plugins' source code is hosted under the [Orama](https://github.com/oramasearch/orama) monorepo, in the [`packages`](https://github.com/oramasearch/orama/tree/main/packages) directory.

If you want to learn more about writing your own plugins, read the guide [available here](/open-source/plugins/writing-your-own-plugins).
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ plugins: [
// ...
```

Make sure you use the correct deploy configuration. Failure to do so will result in compilation failure. see [DelopyType](https://github.com/askorama/orama/blob/77ba63c654068ef718bc84604e11e57dafd7a4d4/packages/plugin-docusaurus-v3/src/index.ts#L14).
Make sure you use the correct deploy configuration. Failure to do so will result in compilation failure. see [DelopyType](https://github.com/oramasearch/orama/blob/77ba63c654068ef718bc84604e11e57dafd7a4d4/packages/plugin-docusaurus-v3/src/index.ts#L14).

To get this variables first create a new integration for HTTP Integrations in here:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Orama currently supports the following units of measurement:
- `yd` (yards)
- `mi` (miles)

All these units will be converted into meters automatically. If you feel like we should support other units of measurement, please [open an issue](https://github.com/askorama/orama/issues)
All these units will be converted into meters automatically. If you feel like we should support other units of measurement, please [open an issue](https://github.com/oramasearch/orama/issues)

### Filtering by bounding polygon

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The key differences between running hybrid search and full-text search are:
1. Instead of searching for a `term` exclusively, you will also need to provide a `vector` object to search.
2. You will need to set `mode` to `"hybrid"` when running search.
3. You will need to specify the vector property you want to search on.
4. At the time of writing, you can only search through one vector property at a time. If you think that this is too limiting, please open a [feature request](https://github.com/askorama/orama/issues/new?assignees=&labels=&projects=&template=feature_request.md&title=) to support multiple vector properties at search-time.
4. At the time of writing, you can only search through one vector property at a time. If you think that this is too limiting, please open a [feature request](https://github.com/oramasearch/orama/issues/new?assignees=&labels=&projects=&template=feature_request.md&title=) to support multiple vector properties at search-time.

Let's see a full example of how to perform vector search:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The key differences between running vector search and full-text search are:

1. Instead of searching for a `term`, you will need to provide a `vector` object to search.
2. You will need to specify the vector property you want to search on.
3. At the time of writing, you can only search through one vector property at a time. If you think that this is too limiting, please open a [feature request](https://github.com/askorama/orama/issues/new?assignees=&labels=&projects=&template=feature_request.md&title=) to support multiple vector properties at search-time.
3. At the time of writing, you can only search through one vector property at a time. If you think that this is too limiting, please open a [feature request](https://github.com/oramasearch/orama/issues/new?assignees=&labels=&projects=&template=feature_request.md&title=) to support multiple vector properties at search-time.

Let's see a full example of how to perform vector search:

Expand Down
4 changes: 2 additions & 2 deletions packages/orama/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img src="https://raw.githubusercontent.com/askorama/orama/refs/heads/main/misc/readme/orama-readme-hero-light.png#gh-light-mode-only" />
<img src="https://raw.githubusercontent.com/oramasearch/orama/refs/heads/main/misc/readme/orama-readme-hero-light.png#gh-light-mode-only" />
</p>

[![Tests](https://github.com/oramasearch/orama/actions/workflows/turbo.yml/badge.svg)](https://github.com/oramasearch/orama/actions/workflows/turbo.yml)
Expand Down Expand Up @@ -53,7 +53,7 @@ Read the complete documentation at [https://docs.orama.com](https://docs.orama.c
# Orama Features

<p align="center">
<img src="https://raw.githubusercontent.com/askorama/orama/refs/heads/main/misc/readme/features-light.png#gh-light-mode-only" />
<img src="https://raw.githubusercontent.com/oramasearch/orama/refs/heads/main/misc/readme/features-light.png#gh-light-mode-only" />
</p>

# Usage
Expand Down
4 changes: 2 additions & 2 deletions packages/orama/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,10 @@
],
"repository": {
"type": "git",
"url": "https://github.com/askorama/orama"
"url": "https://github.com/oramasearch/orama"
},
"bugs": {
"url": "https://github.com/askorama/orama"
"url": "https://github.com/oramasearch/orama"
},
"scripts": {
"benchmark": "node ../../benchmarks/index.js",
Expand Down
2 changes: 1 addition & 1 deletion packages/orama/src/components/sorter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ function insert(sorter: Sorter, prop: string, id: DocumentID, value: SortValue):
// Because we re-use the same internalId
// We need to clean-up the data structure before re-inserting
// to avoid duplicates in the orderedDocs array
// See: https://github.com/askorama/orama/issues/629
// See: https://github.com/oramasearch/orama/issues/629
if (s.orderedDocsToRemove.has(internalId)) {
ensureOrderedDocsAreDeletedByProperty(sorter, prop)
}
Expand Down
4 changes: 2 additions & 2 deletions packages/orama/src/trees/radix.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ export class RadixNode {

// check if _output[w] exists and then add the doc to it
// always check in own property to prevent access to inherited properties
// fix https://github.com/askorama/orama/issues/137
// fix https://github.com/oramasearch/orama/issues/137
if (getOwnProperty(output, w) !== null) {
if (tolerance) {
const difference = Math.abs(term.length - w.length)
Expand All @@ -74,7 +74,7 @@ export class RadixNode {

// check if _output[w] exists and then add the doc to it
// always check in own property to prevent access to inherited properties
// fix https://github.com/askorama/orama/issues/137
// fix https://github.com/oramasearch/orama/issues/137
if (getOwnProperty(output, w) != null && docIDs.size > 0) {
const docs = output[w]
for (const docID of docIDs) {
Expand Down
2 changes: 1 addition & 1 deletion packages/orama/src/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export const isServer = typeof window === 'undefined'
export const MAX_ARGUMENT_FOR_STACK = 65535

/**
* This method is needed to used because of issues like: https://github.com/askorama/orama/issues/301
* This method is needed to used because of issues like: https://github.com/oramasearch/orama/issues/301
* that issue is caused because the array that is pushed is huge (>100k)
*
* @example
Expand Down
2 changes: 1 addition & 1 deletion packages/orama/tests/dataset.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ t.test('orama.dataset', async (t) => {
t.end()
})

// Tests for https://github.com/askorama/orama/issues/159
// Tests for https://github.com/oramasearch/orama/issues/159
t.test('should correctly search long strings', async (t) => {
const s1 = await search(db, {
term: 'e into the',
Expand Down
4 changes: 2 additions & 2 deletions packages/orama/tests/levenshtein.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ t.test('syncBoundedLevenshtein substrings are ok even if with tolerance pppppp',
t.end()
})

// Test cases for https://github.com/askorama/orama/issues/744
// Test cases for https://github.com/oramasearch/orama/issues/744
t.test('Issue #744', async (t) => {
const index = await create({
schema: {
Expand Down Expand Up @@ -239,7 +239,7 @@ t.test('Issue #744', async (t) => {
t.strictSame(s4.hits.map(h => h.id), ['3', '4', '1', '2'])
})

// https://github.com/askorama/orama/issues/797
// https://github.com/oramasearch/orama/issues/797
t.test('Issue #797', async t => {
const db = await create({
schema: {
Expand Down
6 changes: 3 additions & 3 deletions packages/orama/tests/main.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ t.test('should search numbers in supported languages', async (t) => {
t.end()
})

// Tests for https://github.com/askorama/orama/issues/230
// Tests for https://github.com/oramasearch/orama/issues/230
t.test('should correctly search accented words in Italian', async (t) => {
const db = await create({
schema: {
Expand All @@ -175,7 +175,7 @@ t.test('should correctly search accented words in Italian', async (t) => {
t.equal(searchResult.count, 1)
})

// Tests for https://github.com/askorama/orama/issues/230
// Tests for https://github.com/oramasearch/orama/issues/230
t.test('should correctly search accented words in English', async (t) => {
const db = await create({
schema: {
Expand All @@ -196,7 +196,7 @@ t.test('should correctly search accented words in English', async (t) => {
t.equal(searchResult.count, 1)
})

// Tests for https://github.com/askorama/orama/issues/230
// Tests for https://github.com/oramasearch/orama/issues/230
t.test('should correctly search accented words in Dutch', async (t) => {
const db = await create({
schema: {
Expand Down
4 changes: 2 additions & 2 deletions packages/orama/tests/remove.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ t.test('remove method', (t) => {
t.equal(r2_gt.hits[0].id, id2)
})

// Tests for https://github.com/askorama/orama/issues/52
// Tests for https://github.com/oramasearch/orama/issues/52
t.test('should correctly remove documents via substring search', async (t) => {
t.plan(1)

Expand Down Expand Up @@ -271,7 +271,7 @@ t.test('should remove a document and update index field length', async (t) => {
t.same((db.data.index as Index).avgFieldLength, avgFieldLength)
})

// Test cases for issue https://github.com/askorama/orama/issues/486
// Test cases for issue https://github.com/oramasearch/orama/issues/486
t.test('should correctly remove documents with vector properties', async (t) => {
t.plan(2)

Expand Down
2 changes: 1 addition & 1 deletion packages/orama/tests/search.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ t.test('search method', async (t) => {
t.equal(result5.count, 2)
t.equal(result6.count, 4)

// Long string search (Tests for https://github.com/askorama/orama/issues/159 )
// Long string search (Tests for https://github.com/oramasearch/orama/issues/159 )
const result7 = await search(db, { term: 'They are the best'})
const result8 = await search(db, { term: 'Foxes are nice animals'})

Expand Down
2 changes: 1 addition & 1 deletion packages/orama/tests/sort.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -615,7 +615,7 @@ t.test('search with sortBy should be consistent ignoring the insert order', asyn
t.end()
})

// https://github.com/askorama/orama/issues/629
// https://github.com/oramasearch/orama/issues/629
t.test('sort should be consistent after update', async (t) => {
const db = await create({
schema: {
Expand Down
2 changes: 1 addition & 1 deletion packages/orama/tests/type/issue_538.test-d.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/* eslint-disable @typescript-eslint/no-unused-vars */
// https://github.com/askorama/orama/issues/538
// https://github.com/oramasearch/orama/issues/538
import { expectAssignable } from 'tsd'
import { create, search } from '../../src/index.ts'

Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-analytics/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Orama Analytics Plugin

[![Tests](https://github.com/askorama/orama/actions/workflows/turbo.yml/badge.svg)](https://github.com/askorama/orama/actions/workflows/turbo.yml)
[![Tests](https://github.com/oramasearch/orama/actions/workflows/turbo.yml/badge.svg)](https://github.com/oramasearch/orama/actions/workflows/turbo.yml)

Official plugin to provide analytics data on your searches.

Expand Down
6 changes: 3 additions & 3 deletions packages/plugin-analytics/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@
}
},
"bugs": {
"url": "https://github.com/askorama/orama/issues"
"url": "https://github.com/oramasearch/orama/issues"
},
"homepage": "https://github.com/askorama/orama#readme",
"homepage": "https://github.com/oramasearch/orama#readme",
"repository": {
"type": "git",
"url": "git+https://github.com/askorama/orama.git"
"url": "git+https://github.com/oramasearch/orama.git"
},
"sideEffects": false,
"types": "./dist/index.d.ts",
Expand Down
4 changes: 2 additions & 2 deletions packages/plugin-astro/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Orama's Astro Plugin

[![Tests](https://github.com/askorama/orama/actions/workflows/turbo.yml/badge.svg)](https://github.com/askorama/orama/actions/workflows/turbo.yml)
[![Tests](https://github.com/oramasearch/orama/actions/workflows/turbo.yml/badge.svg)](https://github.com/oramasearch/orama/actions/workflows/turbo.yml)

This package is a (still experimental) [Orama](https://askorama.com) integration for
This package is a (still experimental) [Orama](https://oramasearch.com) integration for
[Astro](https://astro.build).

## Usage
Expand Down
Loading

0 comments on commit 9051b71

Please sign in to comment.